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