Typed dictionaries
Index > APIGateway > Typed dictionaries
Auto-generated documentation for APIGateway type annotations stubs module types-aiobotocore-apigateway.
AccessLogSettingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import AccessLogSettingsTypeDef
def get_value() -> AccessLogSettingsTypeDef:
return {
"format": ...,
}
Definition
class AccessLogSettingsTypeDef(TypedDict):
format: NotRequired[str],
destinationArn: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ThrottleSettingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ThrottleSettingsTypeDef
def get_value() -> ThrottleSettingsTypeDef:
return {
"burstLimit": ...,
}
Definition
class ThrottleSettingsTypeDef(TypedDict):
burstLimit: NotRequired[int],
rateLimit: NotRequired[float],
ApiKeyTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ApiKeyTypeDef
def get_value() -> ApiKeyTypeDef:
return {
"id": ...,
}
Definition
class ApiKeyTypeDef(TypedDict):
id: NotRequired[str],
value: NotRequired[str],
name: NotRequired[str],
customerId: NotRequired[str],
description: NotRequired[str],
enabled: NotRequired[bool],
createdDate: NotRequired[datetime],
lastUpdatedDate: NotRequired[datetime],
stageKeys: NotRequired[List[str]],
tags: NotRequired[Dict[str, str]],
AuthorizerTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import AuthorizerTypeDef
def get_value() -> AuthorizerTypeDef:
return {
"id": ...,
}
Definition
class AuthorizerTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
type: NotRequired[AuthorizerTypeType], # (1)
providerARNs: NotRequired[List[str]],
authType: NotRequired[str],
authorizerUri: NotRequired[str],
authorizerCredentials: NotRequired[str],
identitySource: NotRequired[str],
identityValidationExpression: NotRequired[str],
authorizerResultTtlInSeconds: NotRequired[int],
BasePathMappingTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import BasePathMappingTypeDef
def get_value() -> BasePathMappingTypeDef:
return {
"basePath": ...,
}
Definition
class BasePathMappingTypeDef(TypedDict):
basePath: NotRequired[str],
restApiId: NotRequired[str],
stage: NotRequired[str],
CanarySettingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CanarySettingsTypeDef
def get_value() -> CanarySettingsTypeDef:
return {
"percentTraffic": ...,
}
Definition
class CanarySettingsTypeDef(TypedDict):
percentTraffic: NotRequired[float],
deploymentId: NotRequired[str],
stageVariableOverrides: NotRequired[Mapping[str, str]],
useStageCache: NotRequired[bool],
ClientCertificateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ClientCertificateTypeDef
def get_value() -> ClientCertificateTypeDef:
return {
"clientCertificateId": ...,
}
Definition
class ClientCertificateTypeDef(TypedDict):
clientCertificateId: NotRequired[str],
description: NotRequired[str],
pemEncodedCertificate: NotRequired[str],
createdDate: NotRequired[datetime],
expirationDate: NotRequired[datetime],
tags: NotRequired[Dict[str, str]],
StageKeyTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import StageKeyTypeDef
def get_value() -> StageKeyTypeDef:
return {
"restApiId": ...,
}
Definition
class StageKeyTypeDef(TypedDict):
restApiId: NotRequired[str],
stageName: NotRequired[str],
CreateAuthorizerRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateAuthorizerRequestRequestTypeDef
def get_value() -> CreateAuthorizerRequestRequestTypeDef:
return {
"restApiId": ...,
"name": ...,
"type": ...,
}
Definition
class CreateAuthorizerRequestRequestTypeDef(TypedDict):
restApiId: str,
name: str,
type: AuthorizerTypeType, # (1)
providerARNs: NotRequired[Sequence[str]],
authType: NotRequired[str],
authorizerUri: NotRequired[str],
authorizerCredentials: NotRequired[str],
identitySource: NotRequired[str],
identityValidationExpression: NotRequired[str],
authorizerResultTtlInSeconds: NotRequired[int],
CreateBasePathMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateBasePathMappingRequestRequestTypeDef
def get_value() -> CreateBasePathMappingRequestRequestTypeDef:
return {
"domainName": ...,
"restApiId": ...,
}
Definition
class CreateBasePathMappingRequestRequestTypeDef(TypedDict):
domainName: str,
restApiId: str,
basePath: NotRequired[str],
stage: NotRequired[str],
DeploymentCanarySettingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeploymentCanarySettingsTypeDef
def get_value() -> DeploymentCanarySettingsTypeDef:
return {
"percentTraffic": ...,
}
Definition
class DeploymentCanarySettingsTypeDef(TypedDict):
percentTraffic: NotRequired[float],
stageVariableOverrides: NotRequired[Mapping[str, str]],
useStageCache: NotRequired[bool],
DocumentationPartLocationTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationPartLocationTypeDef
def get_value() -> DocumentationPartLocationTypeDef:
return {
"type": ...,
}
Definition
class DocumentationPartLocationTypeDef(TypedDict):
type: DocumentationPartTypeType, # (1)
path: NotRequired[str],
method: NotRequired[str],
statusCode: NotRequired[str],
name: NotRequired[str],
CreateDocumentationVersionRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateDocumentationVersionRequestRequestTypeDef
def get_value() -> CreateDocumentationVersionRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationVersion": ...,
}
Definition
class CreateDocumentationVersionRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationVersion: str,
stageName: NotRequired[str],
description: NotRequired[str],
EndpointConfigurationTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import EndpointConfigurationTypeDef
def get_value() -> EndpointConfigurationTypeDef:
return {
"types": ...,
}
Definition
class EndpointConfigurationTypeDef(TypedDict):
types: NotRequired[Sequence[EndpointTypeType]], # (1)
vpcEndpointIds: NotRequired[Sequence[str]],
- See EndpointTypeType
MutualTlsAuthenticationInputTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MutualTlsAuthenticationInputTypeDef
def get_value() -> MutualTlsAuthenticationInputTypeDef:
return {
"truststoreUri": ...,
}
Definition
class MutualTlsAuthenticationInputTypeDef(TypedDict):
truststoreUri: NotRequired[str],
truststoreVersion: NotRequired[str],
CreateModelRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateModelRequestRequestTypeDef
def get_value() -> CreateModelRequestRequestTypeDef:
return {
"restApiId": ...,
"name": ...,
"contentType": ...,
}
Definition
class CreateModelRequestRequestTypeDef(TypedDict):
restApiId: str,
name: str,
contentType: str,
description: NotRequired[str],
schema: NotRequired[str],
CreateRequestValidatorRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateRequestValidatorRequestRequestTypeDef
def get_value() -> CreateRequestValidatorRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class CreateRequestValidatorRequestRequestTypeDef(TypedDict):
restApiId: str,
name: NotRequired[str],
validateRequestBody: NotRequired[bool],
validateRequestParameters: NotRequired[bool],
CreateResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateResourceRequestRequestTypeDef
def get_value() -> CreateResourceRequestRequestTypeDef:
return {
"restApiId": ...,
"parentId": ...,
"pathPart": ...,
}
Definition
class CreateResourceRequestRequestTypeDef(TypedDict):
restApiId: str,
parentId: str,
pathPart: str,
CreateUsagePlanKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateUsagePlanKeyRequestRequestTypeDef
def get_value() -> CreateUsagePlanKeyRequestRequestTypeDef:
return {
"usagePlanId": ...,
"keyId": ...,
"keyType": ...,
}
Definition
class CreateUsagePlanKeyRequestRequestTypeDef(TypedDict):
usagePlanId: str,
keyId: str,
keyType: str,
QuotaSettingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import QuotaSettingsTypeDef
def get_value() -> QuotaSettingsTypeDef:
return {
"limit": ...,
}
Definition
class QuotaSettingsTypeDef(TypedDict):
limit: NotRequired[int],
offset: NotRequired[int],
period: NotRequired[QuotaPeriodTypeType], # (1)
CreateVpcLinkRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateVpcLinkRequestRequestTypeDef
def get_value() -> CreateVpcLinkRequestRequestTypeDef:
return {
"name": ...,
"targetArns": ...,
}
Definition
class CreateVpcLinkRequestRequestTypeDef(TypedDict):
name: str,
targetArns: Sequence[str],
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
DeleteApiKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteApiKeyRequestRequestTypeDef
def get_value() -> DeleteApiKeyRequestRequestTypeDef:
return {
"apiKey": ...,
}
DeleteAuthorizerRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteAuthorizerRequestRequestTypeDef
def get_value() -> DeleteAuthorizerRequestRequestTypeDef:
return {
"restApiId": ...,
"authorizerId": ...,
}
Definition
class DeleteAuthorizerRequestRequestTypeDef(TypedDict):
restApiId: str,
authorizerId: str,
DeleteBasePathMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteBasePathMappingRequestRequestTypeDef
def get_value() -> DeleteBasePathMappingRequestRequestTypeDef:
return {
"domainName": ...,
"basePath": ...,
}
Definition
class DeleteBasePathMappingRequestRequestTypeDef(TypedDict):
domainName: str,
basePath: str,
DeleteClientCertificateRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteClientCertificateRequestRequestTypeDef
def get_value() -> DeleteClientCertificateRequestRequestTypeDef:
return {
"clientCertificateId": ...,
}
DeleteDeploymentRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteDeploymentRequestRequestTypeDef
def get_value() -> DeleteDeploymentRequestRequestTypeDef:
return {
"restApiId": ...,
"deploymentId": ...,
}
Definition
class DeleteDeploymentRequestRequestTypeDef(TypedDict):
restApiId: str,
deploymentId: str,
DeleteDocumentationPartRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteDocumentationPartRequestRequestTypeDef
def get_value() -> DeleteDocumentationPartRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationPartId": ...,
}
Definition
class DeleteDocumentationPartRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationPartId: str,
DeleteDocumentationVersionRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteDocumentationVersionRequestRequestTypeDef
def get_value() -> DeleteDocumentationVersionRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationVersion": ...,
}
Definition
class DeleteDocumentationVersionRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationVersion: str,
DeleteDomainNameRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteDomainNameRequestRequestTypeDef
def get_value() -> DeleteDomainNameRequestRequestTypeDef:
return {
"domainName": ...,
}
DeleteGatewayResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteGatewayResponseRequestRequestTypeDef
def get_value() -> DeleteGatewayResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"responseType": ...,
}
Definition
class DeleteGatewayResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
DeleteIntegrationRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteIntegrationRequestRequestTypeDef
def get_value() -> DeleteIntegrationRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class DeleteIntegrationRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
DeleteIntegrationResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteIntegrationResponseRequestRequestTypeDef
def get_value() -> DeleteIntegrationResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class DeleteIntegrationResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
DeleteMethodRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteMethodRequestRequestTypeDef
def get_value() -> DeleteMethodRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class DeleteMethodRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
DeleteMethodResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteMethodResponseRequestRequestTypeDef
def get_value() -> DeleteMethodResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class DeleteMethodResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
DeleteModelRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteModelRequestRequestTypeDef
def get_value() -> DeleteModelRequestRequestTypeDef:
return {
"restApiId": ...,
"modelName": ...,
}
DeleteRequestValidatorRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteRequestValidatorRequestRequestTypeDef
def get_value() -> DeleteRequestValidatorRequestRequestTypeDef:
return {
"restApiId": ...,
"requestValidatorId": ...,
}
Definition
class DeleteRequestValidatorRequestRequestTypeDef(TypedDict):
restApiId: str,
requestValidatorId: str,
DeleteResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteResourceRequestRequestTypeDef
def get_value() -> DeleteResourceRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
}
DeleteRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteRestApiRequestRequestTypeDef
def get_value() -> DeleteRestApiRequestRequestTypeDef:
return {
"restApiId": ...,
}
DeleteStageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteStageRequestRequestTypeDef
def get_value() -> DeleteStageRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
}
DeleteUsagePlanKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteUsagePlanKeyRequestRequestTypeDef
def get_value() -> DeleteUsagePlanKeyRequestRequestTypeDef:
return {
"usagePlanId": ...,
"keyId": ...,
}
DeleteUsagePlanRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteUsagePlanRequestRequestTypeDef
def get_value() -> DeleteUsagePlanRequestRequestTypeDef:
return {
"usagePlanId": ...,
}
DeleteVpcLinkRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeleteVpcLinkRequestRequestTypeDef
def get_value() -> DeleteVpcLinkRequestRequestTypeDef:
return {
"vpcLinkId": ...,
}
MethodSnapshotTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodSnapshotTypeDef
def get_value() -> MethodSnapshotTypeDef:
return {
"authorizationType": ...,
}
Definition
class MethodSnapshotTypeDef(TypedDict):
authorizationType: NotRequired[str],
apiKeyRequired: NotRequired[bool],
DocumentationVersionTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationVersionTypeDef
def get_value() -> DocumentationVersionTypeDef:
return {
"version": ...,
}
Definition
class DocumentationVersionTypeDef(TypedDict):
version: NotRequired[str],
createdDate: NotRequired[datetime],
description: NotRequired[str],
MutualTlsAuthenticationTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MutualTlsAuthenticationTypeDef
def get_value() -> MutualTlsAuthenticationTypeDef:
return {
"truststoreUri": ...,
}
Definition
class MutualTlsAuthenticationTypeDef(TypedDict):
truststoreUri: NotRequired[str],
truststoreVersion: NotRequired[str],
truststoreWarnings: NotRequired[List[str]],
FlushStageAuthorizersCacheRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import FlushStageAuthorizersCacheRequestRequestTypeDef
def get_value() -> FlushStageAuthorizersCacheRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
}
Definition
class FlushStageAuthorizersCacheRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: str,
FlushStageCacheRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import FlushStageCacheRequestRequestTypeDef
def get_value() -> FlushStageCacheRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
}
GatewayResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GatewayResponseTypeDef
def get_value() -> GatewayResponseTypeDef:
return {
"responseType": ...,
}
Definition
class GatewayResponseTypeDef(TypedDict):
responseType: NotRequired[GatewayResponseTypeType], # (1)
statusCode: NotRequired[str],
responseParameters: NotRequired[Dict[str, str]],
responseTemplates: NotRequired[Dict[str, str]],
defaultResponse: NotRequired[bool],
GenerateClientCertificateRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GenerateClientCertificateRequestRequestTypeDef
def get_value() -> GenerateClientCertificateRequestRequestTypeDef:
return {
"description": ...,
}
Definition
class GenerateClientCertificateRequestRequestTypeDef(TypedDict):
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
GetApiKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetApiKeyRequestRequestTypeDef
def get_value() -> GetApiKeyRequestRequestTypeDef:
return {
"apiKey": ...,
}
Definition
class GetApiKeyRequestRequestTypeDef(TypedDict):
apiKey: str,
includeValue: NotRequired[bool],
PaginatorConfigTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetApiKeysRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetApiKeysRequestRequestTypeDef
def get_value() -> GetApiKeysRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetApiKeysRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
nameQuery: NotRequired[str],
customerId: NotRequired[str],
includeValues: NotRequired[bool],
GetAuthorizerRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetAuthorizerRequestRequestTypeDef
def get_value() -> GetAuthorizerRequestRequestTypeDef:
return {
"restApiId": ...,
"authorizerId": ...,
}
GetAuthorizersRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetAuthorizersRequestRequestTypeDef
def get_value() -> GetAuthorizersRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetAuthorizersRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetBasePathMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetBasePathMappingRequestRequestTypeDef
def get_value() -> GetBasePathMappingRequestRequestTypeDef:
return {
"domainName": ...,
"basePath": ...,
}
GetBasePathMappingsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetBasePathMappingsRequestRequestTypeDef
def get_value() -> GetBasePathMappingsRequestRequestTypeDef:
return {
"domainName": ...,
}
Definition
class GetBasePathMappingsRequestRequestTypeDef(TypedDict):
domainName: str,
position: NotRequired[str],
limit: NotRequired[int],
GetClientCertificateRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetClientCertificateRequestRequestTypeDef
def get_value() -> GetClientCertificateRequestRequestTypeDef:
return {
"clientCertificateId": ...,
}
GetClientCertificatesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetClientCertificatesRequestRequestTypeDef
def get_value() -> GetClientCertificatesRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetClientCertificatesRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
GetDeploymentRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDeploymentRequestRequestTypeDef
def get_value() -> GetDeploymentRequestRequestTypeDef:
return {
"restApiId": ...,
"deploymentId": ...,
}
Definition
class GetDeploymentRequestRequestTypeDef(TypedDict):
restApiId: str,
deploymentId: str,
embed: NotRequired[Sequence[str]],
GetDeploymentsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDeploymentsRequestRequestTypeDef
def get_value() -> GetDeploymentsRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDeploymentsRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetDocumentationPartRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationPartRequestRequestTypeDef
def get_value() -> GetDocumentationPartRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationPartId": ...,
}
Definition
class GetDocumentationPartRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationPartId: str,
GetDocumentationPartsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationPartsRequestRequestTypeDef
def get_value() -> GetDocumentationPartsRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDocumentationPartsRequestRequestTypeDef(TypedDict):
restApiId: str,
type: NotRequired[DocumentationPartTypeType], # (1)
nameQuery: NotRequired[str],
path: NotRequired[str],
position: NotRequired[str],
limit: NotRequired[int],
locationStatus: NotRequired[LocationStatusTypeType], # (2)
GetDocumentationVersionRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationVersionRequestRequestTypeDef
def get_value() -> GetDocumentationVersionRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationVersion": ...,
}
Definition
class GetDocumentationVersionRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationVersion: str,
GetDocumentationVersionsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationVersionsRequestRequestTypeDef
def get_value() -> GetDocumentationVersionsRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDocumentationVersionsRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetDomainNameRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDomainNameRequestRequestTypeDef
def get_value() -> GetDomainNameRequestRequestTypeDef:
return {
"domainName": ...,
}
GetDomainNamesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDomainNamesRequestRequestTypeDef
def get_value() -> GetDomainNamesRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetDomainNamesRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
GetExportRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetExportRequestRequestTypeDef
def get_value() -> GetExportRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
"exportType": ...,
}
Definition
class GetExportRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: str,
exportType: str,
parameters: NotRequired[Mapping[str, str]],
accepts: NotRequired[str],
GetGatewayResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetGatewayResponseRequestRequestTypeDef
def get_value() -> GetGatewayResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"responseType": ...,
}
Definition
class GetGatewayResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
GetGatewayResponsesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetGatewayResponsesRequestRequestTypeDef
def get_value() -> GetGatewayResponsesRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetGatewayResponsesRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetIntegrationRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetIntegrationRequestRequestTypeDef
def get_value() -> GetIntegrationRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class GetIntegrationRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
GetIntegrationResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetIntegrationResponseRequestRequestTypeDef
def get_value() -> GetIntegrationResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class GetIntegrationResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
GetMethodRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetMethodRequestRequestTypeDef
def get_value() -> GetMethodRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class GetMethodRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
GetMethodResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetMethodResponseRequestRequestTypeDef
def get_value() -> GetMethodResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class GetMethodResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
GetModelRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetModelRequestRequestTypeDef
def get_value() -> GetModelRequestRequestTypeDef:
return {
"restApiId": ...,
"modelName": ...,
}
Definition
class GetModelRequestRequestTypeDef(TypedDict):
restApiId: str,
modelName: str,
flatten: NotRequired[bool],
GetModelTemplateRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetModelTemplateRequestRequestTypeDef
def get_value() -> GetModelTemplateRequestRequestTypeDef:
return {
"restApiId": ...,
"modelName": ...,
}
GetModelsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetModelsRequestRequestTypeDef
def get_value() -> GetModelsRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetModelsRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetRequestValidatorRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRequestValidatorRequestRequestTypeDef
def get_value() -> GetRequestValidatorRequestRequestTypeDef:
return {
"restApiId": ...,
"requestValidatorId": ...,
}
Definition
class GetRequestValidatorRequestRequestTypeDef(TypedDict):
restApiId: str,
requestValidatorId: str,
GetRequestValidatorsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRequestValidatorsRequestRequestTypeDef
def get_value() -> GetRequestValidatorsRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetRequestValidatorsRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
GetResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetResourceRequestRequestTypeDef
def get_value() -> GetResourceRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
}
Definition
class GetResourceRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
embed: NotRequired[Sequence[str]],
GetResourcesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetResourcesRequestRequestTypeDef
def get_value() -> GetResourcesRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetResourcesRequestRequestTypeDef(TypedDict):
restApiId: str,
position: NotRequired[str],
limit: NotRequired[int],
embed: NotRequired[Sequence[str]],
GetRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRestApiRequestRequestTypeDef
def get_value() -> GetRestApiRequestRequestTypeDef:
return {
"restApiId": ...,
}
GetRestApisRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRestApisRequestRequestTypeDef
def get_value() -> GetRestApisRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetRestApisRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
GetSdkRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetSdkRequestRequestTypeDef
def get_value() -> GetSdkRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
"sdkType": ...,
}
Definition
class GetSdkRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: str,
sdkType: str,
parameters: NotRequired[Mapping[str, str]],
GetSdkTypeRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetSdkTypeRequestRequestTypeDef
def get_value() -> GetSdkTypeRequestRequestTypeDef:
return {
"id": ...,
}
GetSdkTypesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetSdkTypesRequestRequestTypeDef
def get_value() -> GetSdkTypesRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetSdkTypesRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
GetStageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetStageRequestRequestTypeDef
def get_value() -> GetStageRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
}
GetStagesRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetStagesRequestRequestTypeDef
def get_value() -> GetStagesRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class GetStagesRequestRequestTypeDef(TypedDict):
restApiId: str,
deploymentId: NotRequired[str],
GetTagsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetTagsRequestRequestTypeDef
def get_value() -> GetTagsRequestRequestTypeDef:
return {
"resourceArn": ...,
}
Definition
class GetTagsRequestRequestTypeDef(TypedDict):
resourceArn: str,
position: NotRequired[str],
limit: NotRequired[int],
GetUsagePlanKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlanKeyRequestRequestTypeDef
def get_value() -> GetUsagePlanKeyRequestRequestTypeDef:
return {
"usagePlanId": ...,
"keyId": ...,
}
GetUsagePlanKeysRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlanKeysRequestRequestTypeDef
def get_value() -> GetUsagePlanKeysRequestRequestTypeDef:
return {
"usagePlanId": ...,
}
Definition
class GetUsagePlanKeysRequestRequestTypeDef(TypedDict):
usagePlanId: str,
position: NotRequired[str],
limit: NotRequired[int],
nameQuery: NotRequired[str],
GetUsagePlanRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlanRequestRequestTypeDef
def get_value() -> GetUsagePlanRequestRequestTypeDef:
return {
"usagePlanId": ...,
}
GetUsagePlansRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlansRequestRequestTypeDef
def get_value() -> GetUsagePlansRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetUsagePlansRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
keyId: NotRequired[str],
limit: NotRequired[int],
GetUsageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsageRequestRequestTypeDef
def get_value() -> GetUsageRequestRequestTypeDef:
return {
"usagePlanId": ...,
"startDate": ...,
"endDate": ...,
}
Definition
class GetUsageRequestRequestTypeDef(TypedDict):
usagePlanId: str,
startDate: str,
endDate: str,
keyId: NotRequired[str],
position: NotRequired[str],
limit: NotRequired[int],
GetVpcLinkRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetVpcLinkRequestRequestTypeDef
def get_value() -> GetVpcLinkRequestRequestTypeDef:
return {
"vpcLinkId": ...,
}
GetVpcLinksRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetVpcLinksRequestRequestTypeDef
def get_value() -> GetVpcLinksRequestRequestTypeDef:
return {
"position": ...,
}
Definition
class GetVpcLinksRequestRequestTypeDef(TypedDict):
position: NotRequired[str],
limit: NotRequired[int],
ImportApiKeysRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ImportApiKeysRequestRequestTypeDef
def get_value() -> ImportApiKeysRequestRequestTypeDef:
return {
"body": ...,
"format": ...,
}
Definition
class ImportApiKeysRequestRequestTypeDef(TypedDict):
body: Union[str, bytes, IO[Any], StreamingBody],
format: ApiKeysFormatType, # (1)
failOnWarnings: NotRequired[bool],
ImportDocumentationPartsRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ImportDocumentationPartsRequestRequestTypeDef
def get_value() -> ImportDocumentationPartsRequestRequestTypeDef:
return {
"restApiId": ...,
"body": ...,
}
Definition
class ImportDocumentationPartsRequestRequestTypeDef(TypedDict):
restApiId: str,
body: Union[str, bytes, IO[Any], StreamingBody],
mode: NotRequired[PutModeType], # (1)
failOnWarnings: NotRequired[bool],
- See PutModeType
ImportRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ImportRestApiRequestRequestTypeDef
def get_value() -> ImportRestApiRequestRequestTypeDef:
return {
"body": ...,
}
Definition
class ImportRestApiRequestRequestTypeDef(TypedDict):
body: Union[str, bytes, IO[Any], StreamingBody],
failOnWarnings: NotRequired[bool],
parameters: NotRequired[Mapping[str, str]],
IntegrationResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import IntegrationResponseTypeDef
def get_value() -> IntegrationResponseTypeDef:
return {
"statusCode": ...,
}
Definition
class IntegrationResponseTypeDef(TypedDict):
statusCode: NotRequired[str],
selectionPattern: NotRequired[str],
responseParameters: NotRequired[Dict[str, str]],
responseTemplates: NotRequired[Dict[str, str]],
contentHandling: NotRequired[ContentHandlingStrategyType], # (1)
TlsConfigTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TlsConfigTypeDef
def get_value() -> TlsConfigTypeDef:
return {
"insecureSkipVerification": ...,
}
MethodResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodResponseTypeDef
def get_value() -> MethodResponseTypeDef:
return {
"statusCode": ...,
}
Definition
class MethodResponseTypeDef(TypedDict):
statusCode: NotRequired[str],
responseParameters: NotRequired[Dict[str, bool]],
responseModels: NotRequired[Dict[str, str]],
MethodSettingTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodSettingTypeDef
def get_value() -> MethodSettingTypeDef:
return {
"metricsEnabled": ...,
}
Definition
class MethodSettingTypeDef(TypedDict):
metricsEnabled: NotRequired[bool],
loggingLevel: NotRequired[str],
dataTraceEnabled: NotRequired[bool],
throttlingBurstLimit: NotRequired[int],
throttlingRateLimit: NotRequired[float],
cachingEnabled: NotRequired[bool],
cacheTtlInSeconds: NotRequired[int],
cacheDataEncrypted: NotRequired[bool],
requireAuthorizationForCacheControl: NotRequired[bool],
unauthorizedCacheControlHeaderStrategy: NotRequired[UnauthorizedCacheControlHeaderStrategyType], # (1)
ModelTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ModelTypeDef
def get_value() -> ModelTypeDef:
return {
"id": ...,
}
Definition
class ModelTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
schema: NotRequired[str],
contentType: NotRequired[str],
PatchOperationTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PatchOperationTypeDef
def get_value() -> PatchOperationTypeDef:
return {
"op": ...,
}
Definition
class PatchOperationTypeDef(TypedDict):
op: NotRequired[OpType], # (1)
path: NotRequired[str],
value: NotRequired[str],
from: NotRequired[str],
- See OpType
PutGatewayResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutGatewayResponseRequestRequestTypeDef
def get_value() -> PutGatewayResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"responseType": ...,
}
Definition
class PutGatewayResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
statusCode: NotRequired[str],
responseParameters: NotRequired[Mapping[str, str]],
responseTemplates: NotRequired[Mapping[str, str]],
PutIntegrationResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutIntegrationResponseRequestRequestTypeDef
def get_value() -> PutIntegrationResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class PutIntegrationResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
selectionPattern: NotRequired[str],
responseParameters: NotRequired[Mapping[str, str]],
responseTemplates: NotRequired[Mapping[str, str]],
contentHandling: NotRequired[ContentHandlingStrategyType], # (1)
PutMethodRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutMethodRequestRequestTypeDef
def get_value() -> PutMethodRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"authorizationType": ...,
}
Definition
class PutMethodRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
authorizationType: str,
authorizerId: NotRequired[str],
apiKeyRequired: NotRequired[bool],
operationName: NotRequired[str],
requestParameters: NotRequired[Mapping[str, bool]],
requestModels: NotRequired[Mapping[str, str]],
requestValidatorId: NotRequired[str],
authorizationScopes: NotRequired[Sequence[str]],
PutMethodResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutMethodResponseRequestRequestTypeDef
def get_value() -> PutMethodResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class PutMethodResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
responseParameters: NotRequired[Mapping[str, bool]],
responseModels: NotRequired[Mapping[str, str]],
PutRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutRestApiRequestRequestTypeDef
def get_value() -> PutRestApiRequestRequestTypeDef:
return {
"restApiId": ...,
"body": ...,
}
Definition
class PutRestApiRequestRequestTypeDef(TypedDict):
restApiId: str,
body: Union[str, bytes, IO[Any], StreamingBody],
mode: NotRequired[PutModeType], # (1)
failOnWarnings: NotRequired[bool],
parameters: NotRequired[Mapping[str, str]],
- See PutModeType
RequestValidatorTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RequestValidatorTypeDef
def get_value() -> RequestValidatorTypeDef:
return {
"id": ...,
}
Definition
class RequestValidatorTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
validateRequestBody: NotRequired[bool],
validateRequestParameters: NotRequired[bool],
SdkConfigurationPropertyTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import SdkConfigurationPropertyTypeDef
def get_value() -> SdkConfigurationPropertyTypeDef:
return {
"name": ...,
}
Definition
class SdkConfigurationPropertyTypeDef(TypedDict):
name: NotRequired[str],
friendlyName: NotRequired[str],
description: NotRequired[str],
required: NotRequired[bool],
defaultValue: NotRequired[str],
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
TestInvokeAuthorizerRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TestInvokeAuthorizerRequestRequestTypeDef
def get_value() -> TestInvokeAuthorizerRequestRequestTypeDef:
return {
"restApiId": ...,
"authorizerId": ...,
}
Definition
class TestInvokeAuthorizerRequestRequestTypeDef(TypedDict):
restApiId: str,
authorizerId: str,
headers: NotRequired[Mapping[str, str]],
multiValueHeaders: NotRequired[Mapping[str, Sequence[str]]],
pathWithQueryString: NotRequired[str],
body: NotRequired[str],
stageVariables: NotRequired[Mapping[str, str]],
additionalContext: NotRequired[Mapping[str, str]],
TestInvokeMethodRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TestInvokeMethodRequestRequestTypeDef
def get_value() -> TestInvokeMethodRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class TestInvokeMethodRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
pathWithQueryString: NotRequired[str],
body: NotRequired[str],
headers: NotRequired[Mapping[str, str]],
multiValueHeaders: NotRequired[Mapping[str, Sequence[str]]],
clientCertificateId: NotRequired[str],
stageVariables: NotRequired[Mapping[str, str]],
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UsagePlanKeyTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlanKeyTypeDef
def get_value() -> UsagePlanKeyTypeDef:
return {
"id": ...,
}
Definition
class UsagePlanKeyTypeDef(TypedDict):
id: NotRequired[str],
type: NotRequired[str],
value: NotRequired[str],
name: NotRequired[str],
VpcLinkTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import VpcLinkTypeDef
def get_value() -> VpcLinkTypeDef:
return {
"id": ...,
}
Definition
class VpcLinkTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
targetArns: NotRequired[List[str]],
status: NotRequired[VpcLinkStatusType], # (1)
statusMessage: NotRequired[str],
tags: NotRequired[Dict[str, str]],
ApiKeyIdsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ApiKeyIdsTypeDef
def get_value() -> ApiKeyIdsTypeDef:
return {
"ids": ...,
"warnings": ...,
"ResponseMetadata": ...,
}
Definition
class ApiKeyIdsTypeDef(TypedDict):
ids: List[str],
warnings: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ApiKeyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ApiKeyResponseMetadataTypeDef
def get_value() -> ApiKeyResponseMetadataTypeDef:
return {
"id": ...,
"value": ...,
"name": ...,
"customerId": ...,
"description": ...,
"enabled": ...,
"createdDate": ...,
"lastUpdatedDate": ...,
"stageKeys": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ApiKeyResponseMetadataTypeDef(TypedDict):
id: str,
value: str,
name: str,
customerId: str,
description: str,
enabled: bool,
createdDate: datetime,
lastUpdatedDate: datetime,
stageKeys: List[str],
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AuthorizerResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import AuthorizerResponseMetadataTypeDef
def get_value() -> AuthorizerResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"type": ...,
"providerARNs": ...,
"authType": ...,
"authorizerUri": ...,
"authorizerCredentials": ...,
"identitySource": ...,
"identityValidationExpression": ...,
"authorizerResultTtlInSeconds": ...,
"ResponseMetadata": ...,
}
Definition
class AuthorizerResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
type: AuthorizerTypeType, # (1)
providerARNs: List[str],
authType: str,
authorizerUri: str,
authorizerCredentials: str,
identitySource: str,
identityValidationExpression: str,
authorizerResultTtlInSeconds: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BasePathMappingResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import BasePathMappingResponseMetadataTypeDef
def get_value() -> BasePathMappingResponseMetadataTypeDef:
return {
"basePath": ...,
"restApiId": ...,
"stage": ...,
"ResponseMetadata": ...,
}
Definition
class BasePathMappingResponseMetadataTypeDef(TypedDict):
basePath: str,
restApiId: str,
stage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ClientCertificateResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ClientCertificateResponseMetadataTypeDef
def get_value() -> ClientCertificateResponseMetadataTypeDef:
return {
"clientCertificateId": ...,
"description": ...,
"pemEncodedCertificate": ...,
"createdDate": ...,
"expirationDate": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ClientCertificateResponseMetadataTypeDef(TypedDict):
clientCertificateId: str,
description: str,
pemEncodedCertificate: str,
createdDate: datetime,
expirationDate: datetime,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DocumentationPartIdsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationPartIdsTypeDef
def get_value() -> DocumentationPartIdsTypeDef:
return {
"ids": ...,
"warnings": ...,
"ResponseMetadata": ...,
}
Definition
class DocumentationPartIdsTypeDef(TypedDict):
ids: List[str],
warnings: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DocumentationVersionResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationVersionResponseMetadataTypeDef
def get_value() -> DocumentationVersionResponseMetadataTypeDef:
return {
"version": ...,
"createdDate": ...,
"description": ...,
"ResponseMetadata": ...,
}
Definition
class DocumentationVersionResponseMetadataTypeDef(TypedDict):
version: str,
createdDate: datetime,
description: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ExportResponseTypeDef
def get_value() -> ExportResponseTypeDef:
return {
"contentType": ...,
"contentDisposition": ...,
"body": ...,
"ResponseMetadata": ...,
}
Definition
class ExportResponseTypeDef(TypedDict):
contentType: str,
contentDisposition: str,
body: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GatewayResponseResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GatewayResponseResponseMetadataTypeDef
def get_value() -> GatewayResponseResponseMetadataTypeDef:
return {
"responseType": ...,
"statusCode": ...,
"responseParameters": ...,
"responseTemplates": ...,
"defaultResponse": ...,
"ResponseMetadata": ...,
}
Definition
class GatewayResponseResponseMetadataTypeDef(TypedDict):
responseType: GatewayResponseTypeType, # (1)
statusCode: str,
responseParameters: Dict[str, str],
responseTemplates: Dict[str, str],
defaultResponse: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
IntegrationResponseResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import IntegrationResponseResponseMetadataTypeDef
def get_value() -> IntegrationResponseResponseMetadataTypeDef:
return {
"statusCode": ...,
"selectionPattern": ...,
"responseParameters": ...,
"responseTemplates": ...,
"contentHandling": ...,
"ResponseMetadata": ...,
}
Definition
class IntegrationResponseResponseMetadataTypeDef(TypedDict):
statusCode: str,
selectionPattern: str,
responseParameters: Dict[str, str],
responseTemplates: Dict[str, str],
contentHandling: ContentHandlingStrategyType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MethodResponseResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodResponseResponseMetadataTypeDef
def get_value() -> MethodResponseResponseMetadataTypeDef:
return {
"statusCode": ...,
"responseParameters": ...,
"responseModels": ...,
"ResponseMetadata": ...,
}
Definition
class MethodResponseResponseMetadataTypeDef(TypedDict):
statusCode: str,
responseParameters: Dict[str, bool],
responseModels: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ModelResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ModelResponseMetadataTypeDef
def get_value() -> ModelResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"description": ...,
"schema": ...,
"contentType": ...,
"ResponseMetadata": ...,
}
Definition
class ModelResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
description: str,
schema: str,
contentType: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RequestValidatorResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RequestValidatorResponseMetadataTypeDef
def get_value() -> RequestValidatorResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"validateRequestBody": ...,
"validateRequestParameters": ...,
"ResponseMetadata": ...,
}
Definition
class RequestValidatorResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
validateRequestBody: bool,
validateRequestParameters: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SdkResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import SdkResponseTypeDef
def get_value() -> SdkResponseTypeDef:
return {
"contentType": ...,
"contentDisposition": ...,
"body": ...,
"ResponseMetadata": ...,
}
Definition
class SdkResponseTypeDef(TypedDict):
contentType: str,
contentDisposition: str,
body: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TagsTypeDef
def get_value() -> TagsTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class TagsTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TemplateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TemplateTypeDef
def get_value() -> TemplateTypeDef:
return {
"value": ...,
"ResponseMetadata": ...,
}
Definition
class TemplateTypeDef(TypedDict):
value: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestInvokeAuthorizerResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TestInvokeAuthorizerResponseTypeDef
def get_value() -> TestInvokeAuthorizerResponseTypeDef:
return {
"clientStatus": ...,
"log": ...,
"latency": ...,
"principalId": ...,
"policy": ...,
"authorization": ...,
"claims": ...,
"ResponseMetadata": ...,
}
Definition
class TestInvokeAuthorizerResponseTypeDef(TypedDict):
clientStatus: int,
log: str,
latency: int,
principalId: str,
policy: str,
authorization: Dict[str, List[str]],
claims: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TestInvokeMethodResponseTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import TestInvokeMethodResponseTypeDef
def get_value() -> TestInvokeMethodResponseTypeDef:
return {
"status": ...,
"body": ...,
"headers": ...,
"multiValueHeaders": ...,
"log": ...,
"latency": ...,
"ResponseMetadata": ...,
}
Definition
class TestInvokeMethodResponseTypeDef(TypedDict):
status: int,
body: str,
headers: Dict[str, str],
multiValueHeaders: Dict[str, List[str]],
log: str,
latency: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UsagePlanKeyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlanKeyResponseMetadataTypeDef
def get_value() -> UsagePlanKeyResponseMetadataTypeDef:
return {
"id": ...,
"type": ...,
"value": ...,
"name": ...,
"ResponseMetadata": ...,
}
Definition
class UsagePlanKeyResponseMetadataTypeDef(TypedDict):
id: str,
type: str,
value: str,
name: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UsageTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsageTypeDef
def get_value() -> UsageTypeDef:
return {
"usagePlanId": ...,
"startDate": ...,
"endDate": ...,
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class UsageTypeDef(TypedDict):
usagePlanId: str,
startDate: str,
endDate: str,
position: str,
items: Dict[str, List[List[int]]],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
VpcLinkResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import VpcLinkResponseMetadataTypeDef
def get_value() -> VpcLinkResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"description": ...,
"targetArns": ...,
"status": ...,
"statusMessage": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class VpcLinkResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
description: str,
targetArns: List[str],
status: VpcLinkStatusType, # (1)
statusMessage: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AccountTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import AccountTypeDef
def get_value() -> AccountTypeDef:
return {
"cloudwatchRoleArn": ...,
"throttleSettings": ...,
"features": ...,
"apiKeyVersion": ...,
"ResponseMetadata": ...,
}
Definition
class AccountTypeDef(TypedDict):
cloudwatchRoleArn: str,
throttleSettings: ThrottleSettingsTypeDef, # (1)
features: List[str],
apiKeyVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ApiStageTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ApiStageTypeDef
def get_value() -> ApiStageTypeDef:
return {
"apiId": ...,
}
Definition
class ApiStageTypeDef(TypedDict):
apiId: NotRequired[str],
stage: NotRequired[str],
throttle: NotRequired[Mapping[str, ThrottleSettingsTypeDef]], # (1)
ApiKeysTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ApiKeysTypeDef
def get_value() -> ApiKeysTypeDef:
return {
"warnings": ...,
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class ApiKeysTypeDef(TypedDict):
warnings: List[str],
position: str,
items: List[ApiKeyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ApiKeyTypeDef
- See ResponseMetadataTypeDef
AuthorizersTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import AuthorizersTypeDef
def get_value() -> AuthorizersTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class AuthorizersTypeDef(TypedDict):
position: str,
items: List[AuthorizerTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BasePathMappingsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import BasePathMappingsTypeDef
def get_value() -> BasePathMappingsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class BasePathMappingsTypeDef(TypedDict):
position: str,
items: List[BasePathMappingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateStageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateStageRequestRequestTypeDef
def get_value() -> CreateStageRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
"deploymentId": ...,
}
Definition
class CreateStageRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: str,
deploymentId: str,
description: NotRequired[str],
cacheClusterEnabled: NotRequired[bool],
cacheClusterSize: NotRequired[CacheClusterSizeType], # (1)
variables: NotRequired[Mapping[str, str]],
documentationVersion: NotRequired[str],
canarySettings: NotRequired[CanarySettingsTypeDef], # (2)
tracingEnabled: NotRequired[bool],
tags: NotRequired[Mapping[str, str]],
ClientCertificatesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ClientCertificatesTypeDef
def get_value() -> ClientCertificatesTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class ClientCertificatesTypeDef(TypedDict):
position: str,
items: List[ClientCertificateTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateApiKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateApiKeyRequestRequestTypeDef
def get_value() -> CreateApiKeyRequestRequestTypeDef:
return {
"name": ...,
}
Definition
class CreateApiKeyRequestRequestTypeDef(TypedDict):
name: NotRequired[str],
description: NotRequired[str],
enabled: NotRequired[bool],
generateDistinctId: NotRequired[bool],
value: NotRequired[str],
stageKeys: NotRequired[Sequence[StageKeyTypeDef]], # (1)
customerId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
- See StageKeyTypeDef
CreateDeploymentRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateDeploymentRequestRequestTypeDef
def get_value() -> CreateDeploymentRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class CreateDeploymentRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: NotRequired[str],
stageDescription: NotRequired[str],
description: NotRequired[str],
cacheClusterEnabled: NotRequired[bool],
cacheClusterSize: NotRequired[CacheClusterSizeType], # (1)
variables: NotRequired[Mapping[str, str]],
canarySettings: NotRequired[DeploymentCanarySettingsTypeDef], # (2)
tracingEnabled: NotRequired[bool],
CreateDocumentationPartRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateDocumentationPartRequestRequestTypeDef
def get_value() -> CreateDocumentationPartRequestRequestTypeDef:
return {
"restApiId": ...,
"location": ...,
"properties": ...,
}
Definition
class CreateDocumentationPartRequestRequestTypeDef(TypedDict):
restApiId: str,
location: DocumentationPartLocationTypeDef, # (1)
properties: str,
DocumentationPartResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationPartResponseMetadataTypeDef
def get_value() -> DocumentationPartResponseMetadataTypeDef:
return {
"id": ...,
"location": ...,
"properties": ...,
"ResponseMetadata": ...,
}
Definition
class DocumentationPartResponseMetadataTypeDef(TypedDict):
id: str,
location: DocumentationPartLocationTypeDef, # (1)
properties: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DocumentationPartTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationPartTypeDef
def get_value() -> DocumentationPartTypeDef:
return {
"id": ...,
}
Definition
class DocumentationPartTypeDef(TypedDict):
id: NotRequired[str],
location: NotRequired[DocumentationPartLocationTypeDef], # (1)
properties: NotRequired[str],
CreateRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateRestApiRequestRequestTypeDef
def get_value() -> CreateRestApiRequestRequestTypeDef:
return {
"name": ...,
}
Definition
class CreateRestApiRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
version: NotRequired[str],
cloneFrom: NotRequired[str],
binaryMediaTypes: NotRequired[Sequence[str]],
minimumCompressionSize: NotRequired[int],
apiKeySource: NotRequired[ApiKeySourceTypeType], # (1)
endpointConfiguration: NotRequired[EndpointConfigurationTypeDef], # (2)
policy: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
disableExecuteApiEndpoint: NotRequired[bool],
RestApiResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RestApiResponseMetadataTypeDef
def get_value() -> RestApiResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"description": ...,
"createdDate": ...,
"version": ...,
"warnings": ...,
"binaryMediaTypes": ...,
"minimumCompressionSize": ...,
"apiKeySource": ...,
"endpointConfiguration": ...,
"policy": ...,
"tags": ...,
"disableExecuteApiEndpoint": ...,
"ResponseMetadata": ...,
}
Definition
class RestApiResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
description: str,
createdDate: datetime,
version: str,
warnings: List[str],
binaryMediaTypes: List[str],
minimumCompressionSize: int,
apiKeySource: ApiKeySourceTypeType, # (1)
endpointConfiguration: EndpointConfigurationTypeDef, # (2)
policy: str,
tags: Dict[str, str],
disableExecuteApiEndpoint: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
RestApiTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RestApiTypeDef
def get_value() -> RestApiTypeDef:
return {
"id": ...,
}
Definition
class RestApiTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
createdDate: NotRequired[datetime],
version: NotRequired[str],
warnings: NotRequired[List[str]],
binaryMediaTypes: NotRequired[List[str]],
minimumCompressionSize: NotRequired[int],
apiKeySource: NotRequired[ApiKeySourceTypeType], # (1)
endpointConfiguration: NotRequired[EndpointConfigurationTypeDef], # (2)
policy: NotRequired[str],
tags: NotRequired[Dict[str, str]],
disableExecuteApiEndpoint: NotRequired[bool],
CreateDomainNameRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateDomainNameRequestRequestTypeDef
def get_value() -> CreateDomainNameRequestRequestTypeDef:
return {
"domainName": ...,
}
Definition
class CreateDomainNameRequestRequestTypeDef(TypedDict):
domainName: str,
certificateName: NotRequired[str],
certificateBody: NotRequired[str],
certificatePrivateKey: NotRequired[str],
certificateChain: NotRequired[str],
certificateArn: NotRequired[str],
regionalCertificateName: NotRequired[str],
regionalCertificateArn: NotRequired[str],
endpointConfiguration: NotRequired[EndpointConfigurationTypeDef], # (1)
tags: NotRequired[Mapping[str, str]],
securityPolicy: NotRequired[SecurityPolicyType], # (2)
mutualTlsAuthentication: NotRequired[MutualTlsAuthenticationInputTypeDef], # (3)
ownershipVerificationCertificateArn: NotRequired[str],
DeploymentResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeploymentResponseMetadataTypeDef
def get_value() -> DeploymentResponseMetadataTypeDef:
return {
"id": ...,
"description": ...,
"createdDate": ...,
"apiSummary": ...,
"ResponseMetadata": ...,
}
Definition
class DeploymentResponseMetadataTypeDef(TypedDict):
id: str,
description: str,
createdDate: datetime,
apiSummary: Dict[str, Dict[str, MethodSnapshotTypeDef]], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeploymentTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeploymentTypeDef
def get_value() -> DeploymentTypeDef:
return {
"id": ...,
}
Definition
class DeploymentTypeDef(TypedDict):
id: NotRequired[str],
description: NotRequired[str],
createdDate: NotRequired[datetime],
apiSummary: NotRequired[Dict[str, Dict[str, MethodSnapshotTypeDef]]], # (1)
DocumentationVersionsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationVersionsTypeDef
def get_value() -> DocumentationVersionsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class DocumentationVersionsTypeDef(TypedDict):
position: str,
items: List[DocumentationVersionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DomainNameResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DomainNameResponseMetadataTypeDef
def get_value() -> DomainNameResponseMetadataTypeDef:
return {
"domainName": ...,
"certificateName": ...,
"certificateArn": ...,
"certificateUploadDate": ...,
"regionalDomainName": ...,
"regionalHostedZoneId": ...,
"regionalCertificateName": ...,
"regionalCertificateArn": ...,
"distributionDomainName": ...,
"distributionHostedZoneId": ...,
"endpointConfiguration": ...,
"domainNameStatus": ...,
"domainNameStatusMessage": ...,
"securityPolicy": ...,
"tags": ...,
"mutualTlsAuthentication": ...,
"ownershipVerificationCertificateArn": ...,
"ResponseMetadata": ...,
}
Definition
class DomainNameResponseMetadataTypeDef(TypedDict):
domainName: str,
certificateName: str,
certificateArn: str,
certificateUploadDate: datetime,
regionalDomainName: str,
regionalHostedZoneId: str,
regionalCertificateName: str,
regionalCertificateArn: str,
distributionDomainName: str,
distributionHostedZoneId: str,
endpointConfiguration: EndpointConfigurationTypeDef, # (1)
domainNameStatus: DomainNameStatusType, # (2)
domainNameStatusMessage: str,
securityPolicy: SecurityPolicyType, # (3)
tags: Dict[str, str],
mutualTlsAuthentication: MutualTlsAuthenticationTypeDef, # (4)
ownershipVerificationCertificateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See EndpointConfigurationTypeDef
- See DomainNameStatusType
- See SecurityPolicyType
- See MutualTlsAuthenticationTypeDef
- See ResponseMetadataTypeDef
DomainNameTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DomainNameTypeDef
def get_value() -> DomainNameTypeDef:
return {
"domainName": ...,
}
Definition
class DomainNameTypeDef(TypedDict):
domainName: NotRequired[str],
certificateName: NotRequired[str],
certificateArn: NotRequired[str],
certificateUploadDate: NotRequired[datetime],
regionalDomainName: NotRequired[str],
regionalHostedZoneId: NotRequired[str],
regionalCertificateName: NotRequired[str],
regionalCertificateArn: NotRequired[str],
distributionDomainName: NotRequired[str],
distributionHostedZoneId: NotRequired[str],
endpointConfiguration: NotRequired[EndpointConfigurationTypeDef], # (1)
domainNameStatus: NotRequired[DomainNameStatusType], # (2)
domainNameStatusMessage: NotRequired[str],
securityPolicy: NotRequired[SecurityPolicyType], # (3)
tags: NotRequired[Dict[str, str]],
mutualTlsAuthentication: NotRequired[MutualTlsAuthenticationTypeDef], # (4)
ownershipVerificationCertificateArn: NotRequired[str],
- See EndpointConfigurationTypeDef
- See DomainNameStatusType
- See SecurityPolicyType
- See MutualTlsAuthenticationTypeDef
GatewayResponsesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GatewayResponsesTypeDef
def get_value() -> GatewayResponsesTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class GatewayResponsesTypeDef(TypedDict):
position: str,
items: List[GatewayResponseTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetApiKeysRequestGetApiKeysPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetApiKeysRequestGetApiKeysPaginateTypeDef
def get_value() -> GetApiKeysRequestGetApiKeysPaginateTypeDef:
return {
"nameQuery": ...,
}
Definition
class GetApiKeysRequestGetApiKeysPaginateTypeDef(TypedDict):
nameQuery: NotRequired[str],
customerId: NotRequired[str],
includeValues: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetAuthorizersRequestGetAuthorizersPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetAuthorizersRequestGetAuthorizersPaginateTypeDef
def get_value() -> GetAuthorizersRequestGetAuthorizersPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetAuthorizersRequestGetAuthorizersPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef
def get_value() -> GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef:
return {
"domainName": ...,
}
Definition
class GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef(TypedDict):
domainName: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef
def get_value() -> GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetDeploymentsRequestGetDeploymentsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDeploymentsRequestGetDeploymentsPaginateTypeDef
def get_value() -> GetDeploymentsRequestGetDeploymentsPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDeploymentsRequestGetDeploymentsPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef
def get_value() -> GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef(TypedDict):
restApiId: str,
type: NotRequired[DocumentationPartTypeType], # (1)
nameQuery: NotRequired[str],
path: NotRequired[str],
locationStatus: NotRequired[LocationStatusTypeType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef
def get_value() -> GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetDomainNamesRequestGetDomainNamesPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetDomainNamesRequestGetDomainNamesPaginateTypeDef
def get_value() -> GetDomainNamesRequestGetDomainNamesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class GetDomainNamesRequestGetDomainNamesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef
def get_value() -> GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetModelsRequestGetModelsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetModelsRequestGetModelsPaginateTypeDef
def get_value() -> GetModelsRequestGetModelsPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetModelsRequestGetModelsPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef
def get_value() -> GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef(TypedDict):
restApiId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetResourcesRequestGetResourcesPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetResourcesRequestGetResourcesPaginateTypeDef
def get_value() -> GetResourcesRequestGetResourcesPaginateTypeDef:
return {
"restApiId": ...,
}
Definition
class GetResourcesRequestGetResourcesPaginateTypeDef(TypedDict):
restApiId: str,
embed: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetRestApisRequestGetRestApisPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetRestApisRequestGetRestApisPaginateTypeDef
def get_value() -> GetRestApisRequestGetRestApisPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class GetRestApisRequestGetRestApisPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetSdkTypesRequestGetSdkTypesPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetSdkTypesRequestGetSdkTypesPaginateTypeDef
def get_value() -> GetSdkTypesRequestGetSdkTypesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class GetSdkTypesRequestGetSdkTypesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef
def get_value() -> GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef:
return {
"usagePlanId": ...,
}
Definition
class GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef(TypedDict):
usagePlanId: str,
nameQuery: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetUsagePlansRequestGetUsagePlansPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsagePlansRequestGetUsagePlansPaginateTypeDef
def get_value() -> GetUsagePlansRequestGetUsagePlansPaginateTypeDef:
return {
"keyId": ...,
}
Definition
class GetUsagePlansRequestGetUsagePlansPaginateTypeDef(TypedDict):
keyId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetUsageRequestGetUsagePaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetUsageRequestGetUsagePaginateTypeDef
def get_value() -> GetUsageRequestGetUsagePaginateTypeDef:
return {
"usagePlanId": ...,
"startDate": ...,
"endDate": ...,
}
Definition
class GetUsageRequestGetUsagePaginateTypeDef(TypedDict):
usagePlanId: str,
startDate: str,
endDate: str,
keyId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetVpcLinksRequestGetVpcLinksPaginateTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import GetVpcLinksRequestGetVpcLinksPaginateTypeDef
def get_value() -> GetVpcLinksRequestGetVpcLinksPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class GetVpcLinksRequestGetVpcLinksPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
IntegrationResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import IntegrationResponseMetadataTypeDef
def get_value() -> IntegrationResponseMetadataTypeDef:
return {
"type": ...,
"httpMethod": ...,
"uri": ...,
"connectionType": ...,
"connectionId": ...,
"credentials": ...,
"requestParameters": ...,
"requestTemplates": ...,
"passthroughBehavior": ...,
"contentHandling": ...,
"timeoutInMillis": ...,
"cacheNamespace": ...,
"cacheKeyParameters": ...,
"integrationResponses": ...,
"tlsConfig": ...,
"ResponseMetadata": ...,
}
Definition
class IntegrationResponseMetadataTypeDef(TypedDict):
type: IntegrationTypeType, # (1)
httpMethod: str,
uri: str,
connectionType: ConnectionTypeType, # (2)
connectionId: str,
credentials: str,
requestParameters: Dict[str, str],
requestTemplates: Dict[str, str],
passthroughBehavior: str,
contentHandling: ContentHandlingStrategyType, # (3)
timeoutInMillis: int,
cacheNamespace: str,
cacheKeyParameters: List[str],
integrationResponses: Dict[str, IntegrationResponseTypeDef], # (4)
tlsConfig: TlsConfigTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See IntegrationTypeType
- See ConnectionTypeType
- See ContentHandlingStrategyType
- See IntegrationResponseTypeDef
- See TlsConfigTypeDef
- See ResponseMetadataTypeDef
IntegrationTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import IntegrationTypeDef
def get_value() -> IntegrationTypeDef:
return {
"type": ...,
}
Definition
class IntegrationTypeDef(TypedDict):
type: NotRequired[IntegrationTypeType], # (1)
httpMethod: NotRequired[str],
uri: NotRequired[str],
connectionType: NotRequired[ConnectionTypeType], # (2)
connectionId: NotRequired[str],
credentials: NotRequired[str],
requestParameters: NotRequired[Dict[str, str]],
requestTemplates: NotRequired[Dict[str, str]],
passthroughBehavior: NotRequired[str],
contentHandling: NotRequired[ContentHandlingStrategyType], # (3)
timeoutInMillis: NotRequired[int],
cacheNamespace: NotRequired[str],
cacheKeyParameters: NotRequired[List[str]],
integrationResponses: NotRequired[Dict[str, IntegrationResponseTypeDef]], # (4)
tlsConfig: NotRequired[TlsConfigTypeDef], # (5)
- See IntegrationTypeType
- See ConnectionTypeType
- See ContentHandlingStrategyType
- See IntegrationResponseTypeDef
- See TlsConfigTypeDef
PutIntegrationRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import PutIntegrationRequestRequestTypeDef
def get_value() -> PutIntegrationRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"type": ...,
}
Definition
class PutIntegrationRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
type: IntegrationTypeType, # (1)
integrationHttpMethod: NotRequired[str],
uri: NotRequired[str],
connectionType: NotRequired[ConnectionTypeType], # (2)
connectionId: NotRequired[str],
credentials: NotRequired[str],
requestParameters: NotRequired[Mapping[str, str]],
requestTemplates: NotRequired[Mapping[str, str]],
passthroughBehavior: NotRequired[str],
cacheNamespace: NotRequired[str],
cacheKeyParameters: NotRequired[Sequence[str]],
contentHandling: NotRequired[ContentHandlingStrategyType], # (3)
timeoutInMillis: NotRequired[int],
tlsConfig: NotRequired[TlsConfigTypeDef], # (4)
StageResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import StageResponseMetadataTypeDef
def get_value() -> StageResponseMetadataTypeDef:
return {
"deploymentId": ...,
"clientCertificateId": ...,
"stageName": ...,
"description": ...,
"cacheClusterEnabled": ...,
"cacheClusterSize": ...,
"cacheClusterStatus": ...,
"methodSettings": ...,
"variables": ...,
"documentationVersion": ...,
"accessLogSettings": ...,
"canarySettings": ...,
"tracingEnabled": ...,
"webAclArn": ...,
"tags": ...,
"createdDate": ...,
"lastUpdatedDate": ...,
"ResponseMetadata": ...,
}
Definition
class StageResponseMetadataTypeDef(TypedDict):
deploymentId: str,
clientCertificateId: str,
stageName: str,
description: str,
cacheClusterEnabled: bool,
cacheClusterSize: CacheClusterSizeType, # (1)
cacheClusterStatus: CacheClusterStatusType, # (2)
methodSettings: Dict[str, MethodSettingTypeDef], # (3)
variables: Dict[str, str],
documentationVersion: str,
accessLogSettings: AccessLogSettingsTypeDef, # (4)
canarySettings: CanarySettingsTypeDef, # (5)
tracingEnabled: bool,
webAclArn: str,
tags: Dict[str, str],
createdDate: datetime,
lastUpdatedDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See CacheClusterSizeType
- See CacheClusterStatusType
- See MethodSettingTypeDef
- See AccessLogSettingsTypeDef
- See CanarySettingsTypeDef
- See ResponseMetadataTypeDef
StageTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import StageTypeDef
def get_value() -> StageTypeDef:
return {
"deploymentId": ...,
}
Definition
class StageTypeDef(TypedDict):
deploymentId: NotRequired[str],
clientCertificateId: NotRequired[str],
stageName: NotRequired[str],
description: NotRequired[str],
cacheClusterEnabled: NotRequired[bool],
cacheClusterSize: NotRequired[CacheClusterSizeType], # (1)
cacheClusterStatus: NotRequired[CacheClusterStatusType], # (2)
methodSettings: NotRequired[Dict[str, MethodSettingTypeDef]], # (3)
variables: NotRequired[Dict[str, str]],
documentationVersion: NotRequired[str],
accessLogSettings: NotRequired[AccessLogSettingsTypeDef], # (4)
canarySettings: NotRequired[CanarySettingsTypeDef], # (5)
tracingEnabled: NotRequired[bool],
webAclArn: NotRequired[str],
tags: NotRequired[Dict[str, str]],
createdDate: NotRequired[datetime],
lastUpdatedDate: NotRequired[datetime],
- See CacheClusterSizeType
- See CacheClusterStatusType
- See MethodSettingTypeDef
- See AccessLogSettingsTypeDef
- See CanarySettingsTypeDef
ModelsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ModelsTypeDef
def get_value() -> ModelsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class ModelsTypeDef(TypedDict):
position: str,
items: List[ModelTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ModelTypeDef
- See ResponseMetadataTypeDef
UpdateAccountRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateAccountRequestRequestTypeDef
def get_value() -> UpdateAccountRequestRequestTypeDef:
return {
"patchOperations": ...,
}
Definition
class UpdateAccountRequestRequestTypeDef(TypedDict):
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateApiKeyRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateApiKeyRequestRequestTypeDef
def get_value() -> UpdateApiKeyRequestRequestTypeDef:
return {
"apiKey": ...,
}
Definition
class UpdateApiKeyRequestRequestTypeDef(TypedDict):
apiKey: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateAuthorizerRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateAuthorizerRequestRequestTypeDef
def get_value() -> UpdateAuthorizerRequestRequestTypeDef:
return {
"restApiId": ...,
"authorizerId": ...,
}
Definition
class UpdateAuthorizerRequestRequestTypeDef(TypedDict):
restApiId: str,
authorizerId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateBasePathMappingRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateBasePathMappingRequestRequestTypeDef
def get_value() -> UpdateBasePathMappingRequestRequestTypeDef:
return {
"domainName": ...,
"basePath": ...,
}
Definition
class UpdateBasePathMappingRequestRequestTypeDef(TypedDict):
domainName: str,
basePath: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateClientCertificateRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateClientCertificateRequestRequestTypeDef
def get_value() -> UpdateClientCertificateRequestRequestTypeDef:
return {
"clientCertificateId": ...,
}
Definition
class UpdateClientCertificateRequestRequestTypeDef(TypedDict):
clientCertificateId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateDeploymentRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateDeploymentRequestRequestTypeDef
def get_value() -> UpdateDeploymentRequestRequestTypeDef:
return {
"restApiId": ...,
"deploymentId": ...,
}
Definition
class UpdateDeploymentRequestRequestTypeDef(TypedDict):
restApiId: str,
deploymentId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateDocumentationPartRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateDocumentationPartRequestRequestTypeDef
def get_value() -> UpdateDocumentationPartRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationPartId": ...,
}
Definition
class UpdateDocumentationPartRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationPartId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateDocumentationVersionRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateDocumentationVersionRequestRequestTypeDef
def get_value() -> UpdateDocumentationVersionRequestRequestTypeDef:
return {
"restApiId": ...,
"documentationVersion": ...,
}
Definition
class UpdateDocumentationVersionRequestRequestTypeDef(TypedDict):
restApiId: str,
documentationVersion: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateDomainNameRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateDomainNameRequestRequestTypeDef
def get_value() -> UpdateDomainNameRequestRequestTypeDef:
return {
"domainName": ...,
}
Definition
class UpdateDomainNameRequestRequestTypeDef(TypedDict):
domainName: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateGatewayResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateGatewayResponseRequestRequestTypeDef
def get_value() -> UpdateGatewayResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"responseType": ...,
}
Definition
class UpdateGatewayResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
responseType: GatewayResponseTypeType, # (1)
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (2)
UpdateIntegrationRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateIntegrationRequestRequestTypeDef
def get_value() -> UpdateIntegrationRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class UpdateIntegrationRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateIntegrationResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateIntegrationResponseRequestRequestTypeDef
def get_value() -> UpdateIntegrationResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class UpdateIntegrationResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateMethodRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateMethodRequestRequestTypeDef
def get_value() -> UpdateMethodRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
}
Definition
class UpdateMethodRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateMethodResponseRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateMethodResponseRequestRequestTypeDef
def get_value() -> UpdateMethodResponseRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
"httpMethod": ...,
"statusCode": ...,
}
Definition
class UpdateMethodResponseRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
httpMethod: str,
statusCode: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateModelRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateModelRequestRequestTypeDef
def get_value() -> UpdateModelRequestRequestTypeDef:
return {
"restApiId": ...,
"modelName": ...,
}
Definition
class UpdateModelRequestRequestTypeDef(TypedDict):
restApiId: str,
modelName: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateRequestValidatorRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateRequestValidatorRequestRequestTypeDef
def get_value() -> UpdateRequestValidatorRequestRequestTypeDef:
return {
"restApiId": ...,
"requestValidatorId": ...,
}
Definition
class UpdateRequestValidatorRequestRequestTypeDef(TypedDict):
restApiId: str,
requestValidatorId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateResourceRequestRequestTypeDef
def get_value() -> UpdateResourceRequestRequestTypeDef:
return {
"restApiId": ...,
"resourceId": ...,
}
Definition
class UpdateResourceRequestRequestTypeDef(TypedDict):
restApiId: str,
resourceId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateRestApiRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateRestApiRequestRequestTypeDef
def get_value() -> UpdateRestApiRequestRequestTypeDef:
return {
"restApiId": ...,
}
Definition
class UpdateRestApiRequestRequestTypeDef(TypedDict):
restApiId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateStageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateStageRequestRequestTypeDef
def get_value() -> UpdateStageRequestRequestTypeDef:
return {
"restApiId": ...,
"stageName": ...,
}
Definition
class UpdateStageRequestRequestTypeDef(TypedDict):
restApiId: str,
stageName: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateUsagePlanRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateUsagePlanRequestRequestTypeDef
def get_value() -> UpdateUsagePlanRequestRequestTypeDef:
return {
"usagePlanId": ...,
}
Definition
class UpdateUsagePlanRequestRequestTypeDef(TypedDict):
usagePlanId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateUsageRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateUsageRequestRequestTypeDef
def get_value() -> UpdateUsageRequestRequestTypeDef:
return {
"usagePlanId": ...,
"keyId": ...,
}
Definition
class UpdateUsageRequestRequestTypeDef(TypedDict):
usagePlanId: str,
keyId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
UpdateVpcLinkRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UpdateVpcLinkRequestRequestTypeDef
def get_value() -> UpdateVpcLinkRequestRequestTypeDef:
return {
"vpcLinkId": ...,
}
Definition
class UpdateVpcLinkRequestRequestTypeDef(TypedDict):
vpcLinkId: str,
patchOperations: NotRequired[Sequence[PatchOperationTypeDef]], # (1)
RequestValidatorsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RequestValidatorsTypeDef
def get_value() -> RequestValidatorsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class RequestValidatorsTypeDef(TypedDict):
position: str,
items: List[RequestValidatorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SdkTypeResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import SdkTypeResponseMetadataTypeDef
def get_value() -> SdkTypeResponseMetadataTypeDef:
return {
"id": ...,
"friendlyName": ...,
"description": ...,
"configurationProperties": ...,
"ResponseMetadata": ...,
}
Definition
class SdkTypeResponseMetadataTypeDef(TypedDict):
id: str,
friendlyName: str,
description: str,
configurationProperties: List[SdkConfigurationPropertyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SdkTypeTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import SdkTypeTypeDef
def get_value() -> SdkTypeTypeDef:
return {
"id": ...,
}
Definition
class SdkTypeTypeDef(TypedDict):
id: NotRequired[str],
friendlyName: NotRequired[str],
description: NotRequired[str],
configurationProperties: NotRequired[List[SdkConfigurationPropertyTypeDef]], # (1)
UsagePlanKeysTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlanKeysTypeDef
def get_value() -> UsagePlanKeysTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class UsagePlanKeysTypeDef(TypedDict):
position: str,
items: List[UsagePlanKeyTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VpcLinksTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import VpcLinksTypeDef
def get_value() -> VpcLinksTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class VpcLinksTypeDef(TypedDict):
position: str,
items: List[VpcLinkTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUsagePlanRequestRequestTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import CreateUsagePlanRequestRequestTypeDef
def get_value() -> CreateUsagePlanRequestRequestTypeDef:
return {
"name": ...,
}
Definition
class CreateUsagePlanRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
apiStages: NotRequired[Sequence[ApiStageTypeDef]], # (1)
throttle: NotRequired[ThrottleSettingsTypeDef], # (2)
quota: NotRequired[QuotaSettingsTypeDef], # (3)
tags: NotRequired[Mapping[str, str]],
UsagePlanResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlanResponseMetadataTypeDef
def get_value() -> UsagePlanResponseMetadataTypeDef:
return {
"id": ...,
"name": ...,
"description": ...,
"apiStages": ...,
"throttle": ...,
"quota": ...,
"productCode": ...,
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class UsagePlanResponseMetadataTypeDef(TypedDict):
id: str,
name: str,
description: str,
apiStages: List[ApiStageTypeDef], # (1)
throttle: ThrottleSettingsTypeDef, # (2)
quota: QuotaSettingsTypeDef, # (3)
productCode: str,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ApiStageTypeDef
- See ThrottleSettingsTypeDef
- See QuotaSettingsTypeDef
- See ResponseMetadataTypeDef
UsagePlanTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlanTypeDef
def get_value() -> UsagePlanTypeDef:
return {
"id": ...,
}
Definition
class UsagePlanTypeDef(TypedDict):
id: NotRequired[str],
name: NotRequired[str],
description: NotRequired[str],
apiStages: NotRequired[List[ApiStageTypeDef]], # (1)
throttle: NotRequired[ThrottleSettingsTypeDef], # (2)
quota: NotRequired[QuotaSettingsTypeDef], # (3)
productCode: NotRequired[str],
tags: NotRequired[Dict[str, str]],
DocumentationPartsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DocumentationPartsTypeDef
def get_value() -> DocumentationPartsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class DocumentationPartsTypeDef(TypedDict):
position: str,
items: List[DocumentationPartTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestApisTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import RestApisTypeDef
def get_value() -> RestApisTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class RestApisTypeDef(TypedDict):
position: str,
items: List[RestApiTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeploymentsTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DeploymentsTypeDef
def get_value() -> DeploymentsTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class DeploymentsTypeDef(TypedDict):
position: str,
items: List[DeploymentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DomainNamesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import DomainNamesTypeDef
def get_value() -> DomainNamesTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class DomainNamesTypeDef(TypedDict):
position: str,
items: List[DomainNameTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MethodResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodResponseMetadataTypeDef
def get_value() -> MethodResponseMetadataTypeDef:
return {
"httpMethod": ...,
"authorizationType": ...,
"authorizerId": ...,
"apiKeyRequired": ...,
"requestValidatorId": ...,
"operationName": ...,
"requestParameters": ...,
"requestModels": ...,
"methodResponses": ...,
"methodIntegration": ...,
"authorizationScopes": ...,
"ResponseMetadata": ...,
}
Definition
class MethodResponseMetadataTypeDef(TypedDict):
httpMethod: str,
authorizationType: str,
authorizerId: str,
apiKeyRequired: bool,
requestValidatorId: str,
operationName: str,
requestParameters: Dict[str, bool],
requestModels: Dict[str, str],
methodResponses: Dict[str, MethodResponseTypeDef], # (1)
methodIntegration: IntegrationTypeDef, # (2)
authorizationScopes: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (3)
MethodTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import MethodTypeDef
def get_value() -> MethodTypeDef:
return {
"httpMethod": ...,
}
Definition
class MethodTypeDef(TypedDict):
httpMethod: NotRequired[str],
authorizationType: NotRequired[str],
authorizerId: NotRequired[str],
apiKeyRequired: NotRequired[bool],
requestValidatorId: NotRequired[str],
operationName: NotRequired[str],
requestParameters: NotRequired[Dict[str, bool]],
requestModels: NotRequired[Dict[str, str]],
methodResponses: NotRequired[Dict[str, MethodResponseTypeDef]], # (1)
methodIntegration: NotRequired[IntegrationTypeDef], # (2)
authorizationScopes: NotRequired[List[str]],
StagesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import StagesTypeDef
def get_value() -> StagesTypeDef:
return {
"item": ...,
"ResponseMetadata": ...,
}
Definition
class StagesTypeDef(TypedDict):
item: List[StageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See StageTypeDef
- See ResponseMetadataTypeDef
SdkTypesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import SdkTypesTypeDef
def get_value() -> SdkTypesTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class SdkTypesTypeDef(TypedDict):
position: str,
items: List[SdkTypeTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UsagePlansTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import UsagePlansTypeDef
def get_value() -> UsagePlansTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}
Definition
class UsagePlansTypeDef(TypedDict):
position: str,
items: List[UsagePlanTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ResourceResponseMetadataTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ResourceResponseMetadataTypeDef
def get_value() -> ResourceResponseMetadataTypeDef:
return {
"id": ...,
"parentId": ...,
"pathPart": ...,
"path": ...,
"resourceMethods": ...,
"ResponseMetadata": ...,
}
Definition
class ResourceResponseMetadataTypeDef(TypedDict):
id: str,
parentId: str,
pathPart: str,
path: str,
resourceMethods: Dict[str, MethodTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See MethodTypeDef
- See ResponseMetadataTypeDef
ResourceTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ResourceTypeDef
def get_value() -> ResourceTypeDef:
return {
"id": ...,
}
Definition
class ResourceTypeDef(TypedDict):
id: NotRequired[str],
parentId: NotRequired[str],
pathPart: NotRequired[str],
path: NotRequired[str],
resourceMethods: NotRequired[Dict[str, MethodTypeDef]], # (1)
- See MethodTypeDef
ResourcesTypeDef
Usage Example
from types_aiobotocore_apigateway.type_defs import ResourcesTypeDef
def get_value() -> ResourcesTypeDef:
return {
"position": ...,
"items": ...,
"ResponseMetadata": ...,
}