Skip to content

Typed dictionaries

Index > APIGateway > Typed dictionaries

Auto-generated documentation for APIGateway type annotations stubs module mypy-boto3-apigateway.

AccessLogSettingsTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import AccessLogSettingsTypeDef

def get_value() -> AccessLogSettingsTypeDef:
    return {
        "format": ...,
    }
Definition
class AccessLogSettingsTypeDef(TypedDict):
    format: NotRequired[str],
    destinationArn: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ThrottleSettingsTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ThrottleSettingsTypeDef

def get_value() -> ThrottleSettingsTypeDef:
    return {
        "burstLimit": ...,
    }
Definition
class ThrottleSettingsTypeDef(TypedDict):
    burstLimit: NotRequired[int],
    rateLimit: NotRequired[float],

ApiKeyTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ApiKeyTypeDef

def get_value() -> ApiKeyTypeDef:
    return {
        "id": ...,
    }
Definition
class ApiKeyTypeDef(TypedDict):
    id: NotRequired[str],
    value: NotRequired[str],
    name: NotRequired[str],
    customerId: NotRequired[str],
    description: NotRequired[str],
    enabled: NotRequired[bool],
    createdDate: NotRequired[datetime],
    lastUpdatedDate: NotRequired[datetime],
    stageKeys: NotRequired[List[str]],
    tags: NotRequired[Dict[str, str]],

AuthorizerTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import AuthorizerTypeDef

def get_value() -> AuthorizerTypeDef:
    return {
        "id": ...,
    }
Definition
class AuthorizerTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    type: NotRequired[AuthorizerTypeType],  # (1)
    providerARNs: NotRequired[List[str]],
    authType: NotRequired[str],
    authorizerUri: NotRequired[str],
    authorizerCredentials: NotRequired[str],
    identitySource: NotRequired[str],
    identityValidationExpression: NotRequired[str],
    authorizerResultTtlInSeconds: NotRequired[int],
  1. See AuthorizerTypeType

BasePathMappingTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import BasePathMappingTypeDef

def get_value() -> BasePathMappingTypeDef:
    return {
        "basePath": ...,
    }
Definition
class BasePathMappingTypeDef(TypedDict):
    basePath: NotRequired[str],
    restApiId: NotRequired[str],
    stage: NotRequired[str],

CanarySettingsTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CanarySettingsTypeDef

def get_value() -> CanarySettingsTypeDef:
    return {
        "percentTraffic": ...,
    }
Definition
class CanarySettingsTypeDef(TypedDict):
    percentTraffic: NotRequired[float],
    deploymentId: NotRequired[str],
    stageVariableOverrides: NotRequired[Mapping[str, str]],
    useStageCache: NotRequired[bool],

ClientCertificateTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ClientCertificateTypeDef

def get_value() -> ClientCertificateTypeDef:
    return {
        "clientCertificateId": ...,
    }
Definition
class ClientCertificateTypeDef(TypedDict):
    clientCertificateId: NotRequired[str],
    description: NotRequired[str],
    pemEncodedCertificate: NotRequired[str],
    createdDate: NotRequired[datetime],
    expirationDate: NotRequired[datetime],
    tags: NotRequired[Dict[str, str]],

StageKeyTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import StageKeyTypeDef

def get_value() -> StageKeyTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class StageKeyTypeDef(TypedDict):
    restApiId: NotRequired[str],
    stageName: NotRequired[str],

CreateAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateAuthorizerRequestRequestTypeDef

def get_value() -> CreateAuthorizerRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "name": ...,
        "type": ...,
    }
Definition
class CreateAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    name: str,
    type: AuthorizerTypeType,  # (1)
    providerARNs: NotRequired[Sequence[str]],
    authType: NotRequired[str],
    authorizerUri: NotRequired[str],
    authorizerCredentials: NotRequired[str],
    identitySource: NotRequired[str],
    identityValidationExpression: NotRequired[str],
    authorizerResultTtlInSeconds: NotRequired[int],
  1. See AuthorizerTypeType

CreateBasePathMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateBasePathMappingRequestRequestTypeDef

def get_value() -> CreateBasePathMappingRequestRequestTypeDef:
    return {
        "domainName": ...,
        "restApiId": ...,
    }
Definition
class CreateBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    restApiId: str,
    basePath: NotRequired[str],
    stage: NotRequired[str],

DeploymentCanarySettingsTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeploymentCanarySettingsTypeDef

def get_value() -> DeploymentCanarySettingsTypeDef:
    return {
        "percentTraffic": ...,
    }
Definition
class DeploymentCanarySettingsTypeDef(TypedDict):
    percentTraffic: NotRequired[float],
    stageVariableOverrides: NotRequired[Mapping[str, str]],
    useStageCache: NotRequired[bool],

DocumentationPartLocationTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DocumentationPartLocationTypeDef

def get_value() -> DocumentationPartLocationTypeDef:
    return {
        "type": ...,
    }
Definition
class DocumentationPartLocationTypeDef(TypedDict):
    type: DocumentationPartTypeType,  # (1)
    path: NotRequired[str],
    method: NotRequired[str],
    statusCode: NotRequired[str],
    name: NotRequired[str],
  1. See DocumentationPartTypeType

CreateDocumentationVersionRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateDocumentationVersionRequestRequestTypeDef

def get_value() -> CreateDocumentationVersionRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "documentationVersion": ...,
    }
Definition
class CreateDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,
    stageName: NotRequired[str],
    description: NotRequired[str],

EndpointConfigurationTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import EndpointConfigurationTypeDef

def get_value() -> EndpointConfigurationTypeDef:
    return {
        "types": ...,
    }
Definition
class EndpointConfigurationTypeDef(TypedDict):
    types: NotRequired[Sequence[EndpointTypeType]],  # (1)
    vpcEndpointIds: NotRequired[Sequence[str]],
  1. See EndpointTypeType

MutualTlsAuthenticationInputTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import MutualTlsAuthenticationInputTypeDef

def get_value() -> MutualTlsAuthenticationInputTypeDef:
    return {
        "truststoreUri": ...,
    }
Definition
class MutualTlsAuthenticationInputTypeDef(TypedDict):
    truststoreUri: NotRequired[str],
    truststoreVersion: NotRequired[str],

CreateModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateModelRequestRequestTypeDef

def get_value() -> CreateModelRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "name": ...,
        "contentType": ...,
    }
Definition
class CreateModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    name: str,
    contentType: str,
    description: NotRequired[str],
    schema: NotRequired[str],

CreateRequestValidatorRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateRequestValidatorRequestRequestTypeDef

def get_value() -> CreateRequestValidatorRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class CreateRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    name: NotRequired[str],
    validateRequestBody: NotRequired[bool],
    validateRequestParameters: NotRequired[bool],

CreateResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateResourceRequestRequestTypeDef

def get_value() -> CreateResourceRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "parentId": ...,
        "pathPart": ...,
    }
Definition
class CreateResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    parentId: str,
    pathPart: str,

CreateUsagePlanKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateUsagePlanKeyRequestRequestTypeDef

def get_value() -> CreateUsagePlanKeyRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
        "keyId": ...,
        "keyType": ...,
    }
Definition
class CreateUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,
    keyType: str,

QuotaSettingsTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import QuotaSettingsTypeDef

def get_value() -> QuotaSettingsTypeDef:
    return {
        "limit": ...,
    }
Definition
class QuotaSettingsTypeDef(TypedDict):
    limit: NotRequired[int],
    offset: NotRequired[int],
    period: NotRequired[QuotaPeriodTypeType],  # (1)
  1. See QuotaPeriodTypeType

CreateVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import CreateVpcLinkRequestRequestTypeDef

def get_value() -> CreateVpcLinkRequestRequestTypeDef:
    return {
        "name": ...,
        "targetArns": ...,
    }
Definition
class CreateVpcLinkRequestRequestTypeDef(TypedDict):
    name: str,
    targetArns: Sequence[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

DeleteApiKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteApiKeyRequestRequestTypeDef

def get_value() -> DeleteApiKeyRequestRequestTypeDef:
    return {
        "apiKey": ...,
    }
Definition
class DeleteApiKeyRequestRequestTypeDef(TypedDict):
    apiKey: str,

DeleteAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteAuthorizerRequestRequestTypeDef

def get_value() -> DeleteAuthorizerRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "authorizerId": ...,
    }
Definition
class DeleteAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    authorizerId: str,

DeleteBasePathMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteBasePathMappingRequestRequestTypeDef

def get_value() -> DeleteBasePathMappingRequestRequestTypeDef:
    return {
        "domainName": ...,
        "basePath": ...,
    }
Definition
class DeleteBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    basePath: str,

DeleteClientCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteClientCertificateRequestRequestTypeDef

def get_value() -> DeleteClientCertificateRequestRequestTypeDef:
    return {
        "clientCertificateId": ...,
    }
Definition
class DeleteClientCertificateRequestRequestTypeDef(TypedDict):
    clientCertificateId: str,

DeleteDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteDeploymentRequestRequestTypeDef

def get_value() -> DeleteDeploymentRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "deploymentId": ...,
    }
Definition
class DeleteDeploymentRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: str,

DeleteDocumentationPartRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteDocumentationPartRequestRequestTypeDef

def get_value() -> DeleteDocumentationPartRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "documentationPartId": ...,
    }
Definition
class DeleteDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationPartId: str,

DeleteDocumentationVersionRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteDocumentationVersionRequestRequestTypeDef

def get_value() -> DeleteDocumentationVersionRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "documentationVersion": ...,
    }
Definition
class DeleteDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,

DeleteDomainNameRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteDomainNameRequestRequestTypeDef

def get_value() -> DeleteDomainNameRequestRequestTypeDef:
    return {
        "domainName": ...,
    }
Definition
class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,

DeleteGatewayResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteGatewayResponseRequestRequestTypeDef

def get_value() -> DeleteGatewayResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "responseType": ...,
    }
Definition
class DeleteGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
  1. See GatewayResponseTypeType

DeleteIntegrationRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteIntegrationRequestRequestTypeDef

def get_value() -> DeleteIntegrationRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
    }
Definition
class DeleteIntegrationRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

DeleteIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteIntegrationResponseRequestRequestTypeDef

def get_value() -> DeleteIntegrationResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
        "statusCode": ...,
    }
Definition
class DeleteIntegrationResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

DeleteMethodRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteMethodRequestRequestTypeDef

def get_value() -> DeleteMethodRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
    }
Definition
class DeleteMethodRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

DeleteMethodResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteMethodResponseRequestRequestTypeDef

def get_value() -> DeleteMethodResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
        "statusCode": ...,
    }
Definition
class DeleteMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

DeleteModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteModelRequestRequestTypeDef

def get_value() -> DeleteModelRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "modelName": ...,
    }
Definition
class DeleteModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,

DeleteRequestValidatorRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteRequestValidatorRequestRequestTypeDef

def get_value() -> DeleteRequestValidatorRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "requestValidatorId": ...,
    }
Definition
class DeleteRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    requestValidatorId: str,

DeleteResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteResourceRequestRequestTypeDef

def get_value() -> DeleteResourceRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
    }
Definition
class DeleteResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,

DeleteRestApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteRestApiRequestRequestTypeDef

def get_value() -> DeleteRestApiRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class DeleteRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,

DeleteStageRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteStageRequestRequestTypeDef

def get_value() -> DeleteStageRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
    }
Definition
class DeleteStageRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

DeleteUsagePlanKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteUsagePlanKeyRequestRequestTypeDef

def get_value() -> DeleteUsagePlanKeyRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
        "keyId": ...,
    }
Definition
class DeleteUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,

DeleteUsagePlanRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteUsagePlanRequestRequestTypeDef

def get_value() -> DeleteUsagePlanRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
    }
Definition
class DeleteUsagePlanRequestRequestTypeDef(TypedDict):
    usagePlanId: str,

DeleteVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DeleteVpcLinkRequestRequestTypeDef

def get_value() -> DeleteVpcLinkRequestRequestTypeDef:
    return {
        "vpcLinkId": ...,
    }
Definition
class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    vpcLinkId: str,

MethodSnapshotTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import MethodSnapshotTypeDef

def get_value() -> MethodSnapshotTypeDef:
    return {
        "authorizationType": ...,
    }
Definition
class MethodSnapshotTypeDef(TypedDict):
    authorizationType: NotRequired[str],
    apiKeyRequired: NotRequired[bool],

DocumentationVersionTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import DocumentationVersionTypeDef

def get_value() -> DocumentationVersionTypeDef:
    return {
        "version": ...,
    }
Definition
class DocumentationVersionTypeDef(TypedDict):
    version: NotRequired[str],
    createdDate: NotRequired[datetime],
    description: NotRequired[str],

MutualTlsAuthenticationTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import MutualTlsAuthenticationTypeDef

def get_value() -> MutualTlsAuthenticationTypeDef:
    return {
        "truststoreUri": ...,
    }
Definition
class MutualTlsAuthenticationTypeDef(TypedDict):
    truststoreUri: NotRequired[str],
    truststoreVersion: NotRequired[str],
    truststoreWarnings: NotRequired[List[str]],

FlushStageAuthorizersCacheRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import FlushStageAuthorizersCacheRequestRequestTypeDef

def get_value() -> FlushStageAuthorizersCacheRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
    }
Definition
class FlushStageAuthorizersCacheRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

FlushStageCacheRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import FlushStageCacheRequestRequestTypeDef

def get_value() -> FlushStageCacheRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
    }
Definition
class FlushStageCacheRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

GatewayResponseTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GatewayResponseTypeDef

def get_value() -> GatewayResponseTypeDef:
    return {
        "responseType": ...,
    }
Definition
class GatewayResponseTypeDef(TypedDict):
    responseType: NotRequired[GatewayResponseTypeType],  # (1)
    statusCode: NotRequired[str],
    responseParameters: NotRequired[Dict[str, str]],
    responseTemplates: NotRequired[Dict[str, str]],
    defaultResponse: NotRequired[bool],
  1. See GatewayResponseTypeType

GenerateClientCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GenerateClientCertificateRequestRequestTypeDef

def get_value() -> GenerateClientCertificateRequestRequestTypeDef:
    return {
        "description": ...,
    }
Definition
class GenerateClientCertificateRequestRequestTypeDef(TypedDict):
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

GetApiKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetApiKeyRequestRequestTypeDef

def get_value() -> GetApiKeyRequestRequestTypeDef:
    return {
        "apiKey": ...,
    }
Definition
class GetApiKeyRequestRequestTypeDef(TypedDict):
    apiKey: str,
    includeValue: NotRequired[bool],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetApiKeysRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetApiKeysRequestRequestTypeDef

def get_value() -> GetApiKeysRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetApiKeysRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],
    nameQuery: NotRequired[str],
    customerId: NotRequired[str],
    includeValues: NotRequired[bool],

GetAuthorizerRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetAuthorizerRequestRequestTypeDef

def get_value() -> GetAuthorizerRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "authorizerId": ...,
    }
Definition
class GetAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    authorizerId: str,

GetAuthorizersRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetAuthorizersRequestRequestTypeDef

def get_value() -> GetAuthorizersRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetAuthorizersRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetBasePathMappingRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetBasePathMappingRequestRequestTypeDef

def get_value() -> GetBasePathMappingRequestRequestTypeDef:
    return {
        "domainName": ...,
        "basePath": ...,
    }
Definition
class GetBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    basePath: str,

GetBasePathMappingsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetBasePathMappingsRequestRequestTypeDef

def get_value() -> GetBasePathMappingsRequestRequestTypeDef:
    return {
        "domainName": ...,
    }
Definition
class GetBasePathMappingsRequestRequestTypeDef(TypedDict):
    domainName: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetClientCertificateRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetClientCertificateRequestRequestTypeDef

def get_value() -> GetClientCertificateRequestRequestTypeDef:
    return {
        "clientCertificateId": ...,
    }
Definition
class GetClientCertificateRequestRequestTypeDef(TypedDict):
    clientCertificateId: str,

GetClientCertificatesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetClientCertificatesRequestRequestTypeDef

def get_value() -> GetClientCertificatesRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetClientCertificatesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetDeploymentRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDeploymentRequestRequestTypeDef

def get_value() -> GetDeploymentRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "deploymentId": ...,
    }
Definition
class GetDeploymentRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: str,
    embed: NotRequired[Sequence[str]],

GetDeploymentsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDeploymentsRequestRequestTypeDef

def get_value() -> GetDeploymentsRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetDeploymentsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetDocumentationPartRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDocumentationPartRequestRequestTypeDef

def get_value() -> GetDocumentationPartRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "documentationPartId": ...,
    }
Definition
class GetDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationPartId: str,

GetDocumentationPartsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDocumentationPartsRequestRequestTypeDef

def get_value() -> GetDocumentationPartsRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetDocumentationPartsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    type: NotRequired[DocumentationPartTypeType],  # (1)
    nameQuery: NotRequired[str],
    path: NotRequired[str],
    position: NotRequired[str],
    limit: NotRequired[int],
    locationStatus: NotRequired[LocationStatusTypeType],  # (2)
  1. See DocumentationPartTypeType
  2. See LocationStatusTypeType

GetDocumentationVersionRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDocumentationVersionRequestRequestTypeDef

def get_value() -> GetDocumentationVersionRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "documentationVersion": ...,
    }
Definition
class GetDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,

GetDocumentationVersionsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDocumentationVersionsRequestRequestTypeDef

def get_value() -> GetDocumentationVersionsRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetDocumentationVersionsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetDomainNameRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDomainNameRequestRequestTypeDef

def get_value() -> GetDomainNameRequestRequestTypeDef:
    return {
        "domainName": ...,
    }
Definition
class GetDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,

GetDomainNamesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetDomainNamesRequestRequestTypeDef

def get_value() -> GetDomainNamesRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetDomainNamesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetExportRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetExportRequestRequestTypeDef

def get_value() -> GetExportRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
        "exportType": ...,
    }
Definition
class GetExportRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,
    exportType: str,
    parameters: NotRequired[Mapping[str, str]],
    accepts: NotRequired[str],

GetGatewayResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetGatewayResponseRequestRequestTypeDef

def get_value() -> GetGatewayResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "responseType": ...,
    }
Definition
class GetGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
  1. See GatewayResponseTypeType

GetGatewayResponsesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetGatewayResponsesRequestRequestTypeDef

def get_value() -> GetGatewayResponsesRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetGatewayResponsesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetIntegrationRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetIntegrationRequestRequestTypeDef

def get_value() -> GetIntegrationRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
    }
Definition
class GetIntegrationRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

GetIntegrationResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetIntegrationResponseRequestRequestTypeDef

def get_value() -> GetIntegrationResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
        "statusCode": ...,
    }
Definition
class GetIntegrationResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

GetMethodRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetMethodRequestRequestTypeDef

def get_value() -> GetMethodRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
    }
Definition
class GetMethodRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

GetMethodResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetMethodResponseRequestRequestTypeDef

def get_value() -> GetMethodResponseRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
        "httpMethod": ...,
        "statusCode": ...,
    }
Definition
class GetMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

GetModelRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetModelRequestRequestTypeDef

def get_value() -> GetModelRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "modelName": ...,
    }
Definition
class GetModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,
    flatten: NotRequired[bool],

GetModelTemplateRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetModelTemplateRequestRequestTypeDef

def get_value() -> GetModelTemplateRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "modelName": ...,
    }
Definition
class GetModelTemplateRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,

GetModelsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetModelsRequestRequestTypeDef

def get_value() -> GetModelsRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetModelsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetRequestValidatorRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetRequestValidatorRequestRequestTypeDef

def get_value() -> GetRequestValidatorRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "requestValidatorId": ...,
    }
Definition
class GetRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    requestValidatorId: str,

GetRequestValidatorsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetRequestValidatorsRequestRequestTypeDef

def get_value() -> GetRequestValidatorsRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetRequestValidatorsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetResourceRequestRequestTypeDef

def get_value() -> GetResourceRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "resourceId": ...,
    }
Definition
class GetResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    embed: NotRequired[Sequence[str]],

GetResourcesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetResourcesRequestRequestTypeDef

def get_value() -> GetResourcesRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetResourcesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],
    embed: NotRequired[Sequence[str]],

GetRestApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetRestApiRequestRequestTypeDef

def get_value() -> GetRestApiRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,

GetRestApisRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetRestApisRequestRequestTypeDef

def get_value() -> GetRestApisRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetRestApisRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetSdkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetSdkRequestRequestTypeDef

def get_value() -> GetSdkRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
        "sdkType": ...,
    }
Definition
class GetSdkRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,
    sdkType: str,
    parameters: NotRequired[Mapping[str, str]],

GetSdkTypeRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetSdkTypeRequestRequestTypeDef

def get_value() -> GetSdkTypeRequestRequestTypeDef:
    return {
        "id": ...,
    }
Definition
class GetSdkTypeRequestRequestTypeDef(TypedDict):
    id: str,

GetSdkTypesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetSdkTypesRequestRequestTypeDef

def get_value() -> GetSdkTypesRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetSdkTypesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetStageRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetStageRequestRequestTypeDef

def get_value() -> GetStageRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "stageName": ...,
    }
Definition
class GetStageRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

GetStagesRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetStagesRequestRequestTypeDef

def get_value() -> GetStagesRequestRequestTypeDef:
    return {
        "restApiId": ...,
    }
Definition
class GetStagesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: NotRequired[str],

GetTagsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetTagsRequestRequestTypeDef

def get_value() -> GetTagsRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class GetTagsRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetUsagePlanKeyRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetUsagePlanKeyRequestRequestTypeDef

def get_value() -> GetUsagePlanKeyRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
        "keyId": ...,
    }
Definition
class GetUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,

GetUsagePlanKeysRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetUsagePlanKeysRequestRequestTypeDef

def get_value() -> GetUsagePlanKeysRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
    }
Definition
class GetUsagePlanKeysRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    position: NotRequired[str],
    limit: NotRequired[int],
    nameQuery: NotRequired[str],

GetUsagePlanRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetUsagePlanRequestRequestTypeDef

def get_value() -> GetUsagePlanRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
    }
Definition
class GetUsagePlanRequestRequestTypeDef(TypedDict):
    usagePlanId: str,

GetUsagePlansRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetUsagePlansRequestRequestTypeDef

def get_value() -> GetUsagePlansRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetUsagePlansRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    keyId: NotRequired[str],
    limit: NotRequired[int],

GetUsageRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetUsageRequestRequestTypeDef

def get_value() -> GetUsageRequestRequestTypeDef:
    return {
        "usagePlanId": ...,
        "startDate": ...,
        "endDate": ...,
    }
Definition
class GetUsageRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    startDate: str,
    endDate: str,
    keyId: NotRequired[str],
    position: NotRequired[str],
    limit: NotRequired[int],

GetVpcLinkRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetVpcLinkRequestRequestTypeDef

def get_value() -> GetVpcLinkRequestRequestTypeDef:
    return {
        "vpcLinkId": ...,
    }
Definition
class GetVpcLinkRequestRequestTypeDef(TypedDict):
    vpcLinkId: str,

GetVpcLinksRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import GetVpcLinksRequestRequestTypeDef

def get_value() -> GetVpcLinksRequestRequestTypeDef:
    return {
        "position": ...,
    }
Definition
class GetVpcLinksRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

ImportApiKeysRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ImportApiKeysRequestRequestTypeDef

def get_value() -> ImportApiKeysRequestRequestTypeDef:
    return {
        "body": ...,
        "format": ...,
    }
Definition
class ImportApiKeysRequestRequestTypeDef(TypedDict):
    body: Union[str, bytes, IO[Any], StreamingBody],
    format: ApiKeysFormatType,  # (1)
    failOnWarnings: NotRequired[bool],
  1. See ApiKeysFormatType

ImportDocumentationPartsRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ImportDocumentationPartsRequestRequestTypeDef

def get_value() -> ImportDocumentationPartsRequestRequestTypeDef:
    return {
        "restApiId": ...,
        "body": ...,
    }
Definition
class ImportDocumentationPartsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    body: Union[str, bytes, IO[Any], StreamingBody],
    mode: NotRequired[PutModeType],  # (1)
    failOnWarnings: NotRequired[bool],
  1. See PutModeType

ImportRestApiRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ImportRestApiRequestRequestTypeDef

def get_value() -> ImportRestApiRequestRequestTypeDef:
    return {
        "body": ...,
    }
Definition
class ImportRestApiRequestRequestTypeDef(TypedDict):
    body: Union[str, bytes, IO[Any], StreamingBody],
    failOnWarnings: NotRequired[bool],
    parameters: NotRequired[Mapping[str, str]],

IntegrationResponseTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import IntegrationResponseTypeDef

def get_value() -> IntegrationResponseTypeDef:
    return {
        "statusCode": ...,
    }
Definition
class IntegrationResponseTypeDef(TypedDict):
    statusCode: NotRequired[str],
    selectionPattern: NotRequired[str],
    responseParameters: NotRequired[Dict[str, str]],
    responseTemplates: NotRequired[Dict[str, str]],
    contentHandling: NotRequired[ContentHandlingStrategyType],  # (1)
  1. See ContentHandlingStrategyType

TlsConfigTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import TlsConfigTypeDef

def get_value() -> TlsConfigTypeDef:
    return {
        "insecureSkipVerification": ...,
    }
Definition
class TlsConfigTypeDef(TypedDict):
    insecureSkipVerification: NotRequired[bool],

MethodResponseTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import MethodResponseTypeDef

def get_value() -> MethodResponseTypeDef:
    return {
        "statusCode": ...,
    }
Definition
class MethodResponseTypeDef(TypedDict):
    statusCode: NotRequired[str],
    responseParameters: NotRequired[Dict[str, bool]],
    responseModels: NotRequired[Dict[str, str]],

MethodSettingTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import MethodSettingTypeDef

def get_value() -> MethodSettingTypeDef:
    return {
        "metricsEnabled": ...,
    }
Definition
class MethodSettingTypeDef(TypedDict):
    metricsEnabled: NotRequired[bool],
    loggingLevel: NotRequired[str],
    dataTraceEnabled: NotRequired[bool],
    throttlingBurstLimit: NotRequired[int],
    throttlingRateLimit: NotRequired[float],
    cachingEnabled: NotRequired[bool],
    cacheTtlInSeconds: NotRequired[int],
    cacheDataEncrypted: NotRequired[bool],
    requireAuthorizationForCacheControl: NotRequired[bool],
    unauthorizedCacheControlHeaderStrategy: NotRequired[UnauthorizedCacheControlHeaderStrategyType],  # (1)
  1. See UnauthorizedCacheControlHeaderStrategyType

ModelTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import ModelTypeDef

def get_value() -> ModelTypeDef:
    return {
        "id": ...,
    }
Definition
class ModelTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    schema: NotRequired[str],
    contentType: NotRequired[str],

PatchOperationTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import PatchOperationTypeDef

def get_value() -> PatchOperationTypeDef:
    return {
        "op": ...,
    }
Definition
class PatchOperationTypeDef(TypedDict):
    op: NotRequired[OpType],  # (1)
    path: NotRequired[str],
    value: NotRequired[str],
    from: NotRequired[str],
  1. See OpType

PutGatewayResponseRequestRequestTypeDef

Usage Example
from mypy_boto3_apigateway.type_defs import PutGatewayResponseRequestRequestTypeDef

def get_value() -> PutGatewayResponseRequestRequestTypeDef:
    r