Skip to content

Type definitions#

Index > APIGateway > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

ApiStageUnionTypeDef#

# ApiStageUnionTypeDef definition

ApiStageUnionTypeDef = Union[
    ApiStageTypeDef,  # (1)
    ApiStageOutputTypeDef,  # (2)
]
  1. See ApiStageTypeDef
  2. See ApiStageOutputTypeDef

AccessLogSettingsTypeDef#

# AccessLogSettingsTypeDef definition

class AccessLogSettingsTypeDef(TypedDict):
    format: NotRequired[str],
    destinationArn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ThrottleSettingsTypeDef#

# ThrottleSettingsTypeDef definition

class ThrottleSettingsTypeDef(TypedDict):
    burstLimit: NotRequired[int],
    rateLimit: NotRequired[float],

ApiKeyTypeDef#

# 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]],

AuthorizerTypeDef#

# 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],
  1. See AuthorizerTypeType

BasePathMappingTypeDef#

# BasePathMappingTypeDef definition

class BasePathMappingTypeDef(TypedDict):
    basePath: NotRequired[str],
    restApiId: NotRequired[str],
    stage: NotRequired[str],

CanarySettingsOutputTypeDef#

# CanarySettingsOutputTypeDef definition

class CanarySettingsOutputTypeDef(TypedDict):
    percentTraffic: NotRequired[float],
    deploymentId: NotRequired[str],
    stageVariableOverrides: NotRequired[Dict[str, str]],
    useStageCache: NotRequired[bool],

CanarySettingsTypeDef#

# CanarySettingsTypeDef definition

class CanarySettingsTypeDef(TypedDict):
    percentTraffic: NotRequired[float],
    deploymentId: NotRequired[str],
    stageVariableOverrides: NotRequired[Mapping[str, str]],
    useStageCache: NotRequired[bool],

ClientCertificateTypeDef#

# 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 definition

class StageKeyTypeDef(TypedDict):
    restApiId: NotRequired[str],
    stageName: NotRequired[str],

CreateAuthorizerRequestRequestTypeDef#

# 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],
  1. See AuthorizerTypeType

CreateBasePathMappingRequestRequestTypeDef#

# CreateBasePathMappingRequestRequestTypeDef definition

class CreateBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    restApiId: str,
    domainNameId: NotRequired[str],
    basePath: NotRequired[str],
    stage: NotRequired[str],

DeploymentCanarySettingsTypeDef#

# DeploymentCanarySettingsTypeDef definition

class DeploymentCanarySettingsTypeDef(TypedDict):
    percentTraffic: NotRequired[float],
    stageVariableOverrides: NotRequired[Mapping[str, str]],
    useStageCache: NotRequired[bool],

DocumentationPartLocationTypeDef#

# DocumentationPartLocationTypeDef definition

class DocumentationPartLocationTypeDef(TypedDict):
    type: DocumentationPartTypeType,  # (1)
    path: NotRequired[str],
    method: NotRequired[str],
    statusCode: NotRequired[str],
    name: NotRequired[str],
  1. See DocumentationPartTypeType

CreateDocumentationVersionRequestRequestTypeDef#

# CreateDocumentationVersionRequestRequestTypeDef definition

class CreateDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,
    stageName: NotRequired[str],
    description: NotRequired[str],

CreateDomainNameAccessAssociationRequestRequestTypeDef#

# CreateDomainNameAccessAssociationRequestRequestTypeDef definition

class CreateDomainNameAccessAssociationRequestRequestTypeDef(TypedDict):
    domainNameArn: str,
    accessAssociationSourceType: AccessAssociationSourceTypeType,  # (1)
    accessAssociationSource: str,
    tags: NotRequired[Mapping[str, str]],
  1. See AccessAssociationSourceTypeType

EndpointConfigurationTypeDef#

# EndpointConfigurationTypeDef definition

class EndpointConfigurationTypeDef(TypedDict):
    types: NotRequired[Sequence[EndpointTypeType]],  # (1)
    vpcEndpointIds: NotRequired[Sequence[str]],
  1. See EndpointTypeType

MutualTlsAuthenticationInputTypeDef#

# MutualTlsAuthenticationInputTypeDef definition

class MutualTlsAuthenticationInputTypeDef(TypedDict):
    truststoreUri: NotRequired[str],
    truststoreVersion: NotRequired[str],

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef definition

class CreateModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    name: str,
    contentType: str,
    description: NotRequired[str],
    schema: NotRequired[str],

CreateRequestValidatorRequestRequestTypeDef#

# CreateRequestValidatorRequestRequestTypeDef definition

class CreateRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    name: NotRequired[str],
    validateRequestBody: NotRequired[bool],
    validateRequestParameters: NotRequired[bool],

CreateResourceRequestRequestTypeDef#

# CreateResourceRequestRequestTypeDef definition

class CreateResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    parentId: str,
    pathPart: str,

CreateUsagePlanKeyRequestRequestTypeDef#

# CreateUsagePlanKeyRequestRequestTypeDef definition

class CreateUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,
    keyType: str,

QuotaSettingsTypeDef#

# QuotaSettingsTypeDef definition

class QuotaSettingsTypeDef(TypedDict):
    limit: NotRequired[int],
    offset: NotRequired[int],
    period: NotRequired[QuotaPeriodTypeType],  # (1)
  1. See QuotaPeriodTypeType

CreateVpcLinkRequestRequestTypeDef#

# CreateVpcLinkRequestRequestTypeDef definition

class CreateVpcLinkRequestRequestTypeDef(TypedDict):
    name: str,
    targetArns: Sequence[str],
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

DeleteApiKeyRequestRequestTypeDef#

# DeleteApiKeyRequestRequestTypeDef definition

class DeleteApiKeyRequestRequestTypeDef(TypedDict):
    apiKey: str,

DeleteAuthorizerRequestRequestTypeDef#

# DeleteAuthorizerRequestRequestTypeDef definition

class DeleteAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    authorizerId: str,

DeleteBasePathMappingRequestRequestTypeDef#

# DeleteBasePathMappingRequestRequestTypeDef definition

class DeleteBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    basePath: str,
    domainNameId: NotRequired[str],

DeleteClientCertificateRequestRequestTypeDef#

# DeleteClientCertificateRequestRequestTypeDef definition

class DeleteClientCertificateRequestRequestTypeDef(TypedDict):
    clientCertificateId: str,

DeleteDeploymentRequestRequestTypeDef#

# DeleteDeploymentRequestRequestTypeDef definition

class DeleteDeploymentRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: str,

DeleteDocumentationPartRequestRequestTypeDef#

# DeleteDocumentationPartRequestRequestTypeDef definition

class DeleteDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationPartId: str,

DeleteDocumentationVersionRequestRequestTypeDef#

# DeleteDocumentationVersionRequestRequestTypeDef definition

class DeleteDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,

DeleteDomainNameAccessAssociationRequestRequestTypeDef#

# DeleteDomainNameAccessAssociationRequestRequestTypeDef definition

class DeleteDomainNameAccessAssociationRequestRequestTypeDef(TypedDict):
    domainNameAccessAssociationArn: str,

DeleteDomainNameRequestRequestTypeDef#

# DeleteDomainNameRequestRequestTypeDef definition

class DeleteDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,
    domainNameId: NotRequired[str],

DeleteGatewayResponseRequestRequestTypeDef#

# DeleteGatewayResponseRequestRequestTypeDef definition

class DeleteGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
  1. See GatewayResponseTypeType

DeleteIntegrationRequestRequestTypeDef#

# DeleteIntegrationRequestRequestTypeDef definition

class DeleteIntegrationRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

DeleteIntegrationResponseRequestRequestTypeDef#

# DeleteIntegrationResponseRequestRequestTypeDef definition

class DeleteIntegrationResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

DeleteMethodRequestRequestTypeDef#

# DeleteMethodRequestRequestTypeDef definition

class DeleteMethodRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

DeleteMethodResponseRequestRequestTypeDef#

# DeleteMethodResponseRequestRequestTypeDef definition

class DeleteMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef definition

class DeleteModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,

DeleteRequestValidatorRequestRequestTypeDef#

# DeleteRequestValidatorRequestRequestTypeDef definition

class DeleteRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    requestValidatorId: str,

DeleteResourceRequestRequestTypeDef#

# DeleteResourceRequestRequestTypeDef definition

class DeleteResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,

DeleteRestApiRequestRequestTypeDef#

# DeleteRestApiRequestRequestTypeDef definition

class DeleteRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,

DeleteStageRequestRequestTypeDef#

# DeleteStageRequestRequestTypeDef definition

class DeleteStageRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

DeleteUsagePlanKeyRequestRequestTypeDef#

# DeleteUsagePlanKeyRequestRequestTypeDef definition

class DeleteUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,

DeleteUsagePlanRequestRequestTypeDef#

# DeleteUsagePlanRequestRequestTypeDef definition

class DeleteUsagePlanRequestRequestTypeDef(TypedDict):
    usagePlanId: str,

DeleteVpcLinkRequestRequestTypeDef#

# DeleteVpcLinkRequestRequestTypeDef definition

class DeleteVpcLinkRequestRequestTypeDef(TypedDict):
    vpcLinkId: str,

MethodSnapshotTypeDef#

# MethodSnapshotTypeDef definition

class MethodSnapshotTypeDef(TypedDict):
    authorizationType: NotRequired[str],
    apiKeyRequired: NotRequired[bool],

DocumentationVersionTypeDef#

# DocumentationVersionTypeDef definition

class DocumentationVersionTypeDef(TypedDict):
    version: NotRequired[str],
    createdDate: NotRequired[datetime],
    description: NotRequired[str],

DomainNameAccessAssociationTypeDef#

# DomainNameAccessAssociationTypeDef definition

class DomainNameAccessAssociationTypeDef(TypedDict):
    domainNameAccessAssociationArn: NotRequired[str],
    domainNameArn: NotRequired[str],
    accessAssociationSourceType: NotRequired[AccessAssociationSourceTypeType],  # (1)
    accessAssociationSource: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See AccessAssociationSourceTypeType

EndpointConfigurationOutputTypeDef#

# EndpointConfigurationOutputTypeDef definition

class EndpointConfigurationOutputTypeDef(TypedDict):
    types: NotRequired[List[EndpointTypeType]],  # (1)
    vpcEndpointIds: NotRequired[List[str]],
  1. See EndpointTypeType

MutualTlsAuthenticationTypeDef#

# MutualTlsAuthenticationTypeDef definition

class MutualTlsAuthenticationTypeDef(TypedDict):
    truststoreUri: NotRequired[str],
    truststoreVersion: NotRequired[str],
    truststoreWarnings: NotRequired[List[str]],

FlushStageAuthorizersCacheRequestRequestTypeDef#

# FlushStageAuthorizersCacheRequestRequestTypeDef definition

class FlushStageAuthorizersCacheRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

FlushStageCacheRequestRequestTypeDef#

# FlushStageCacheRequestRequestTypeDef definition

class FlushStageCacheRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

GatewayResponseTypeDef#

# 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],
  1. See GatewayResponseTypeType

GenerateClientCertificateRequestRequestTypeDef#

# GenerateClientCertificateRequestRequestTypeDef definition

class GenerateClientCertificateRequestRequestTypeDef(TypedDict):
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

GetApiKeyRequestRequestTypeDef#

# GetApiKeyRequestRequestTypeDef definition

class GetApiKeyRequestRequestTypeDef(TypedDict):
    apiKey: str,
    includeValue: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetApiKeysRequestRequestTypeDef#

# GetApiKeysRequestRequestTypeDef definition

class GetApiKeysRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],
    nameQuery: NotRequired[str],
    customerId: NotRequired[str],
    includeValues: NotRequired[bool],

GetAuthorizerRequestRequestTypeDef#

# GetAuthorizerRequestRequestTypeDef definition

class GetAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    authorizerId: str,

GetAuthorizersRequestRequestTypeDef#

# GetAuthorizersRequestRequestTypeDef definition

class GetAuthorizersRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetBasePathMappingRequestRequestTypeDef#

# GetBasePathMappingRequestRequestTypeDef definition

class GetBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    basePath: str,
    domainNameId: NotRequired[str],

GetBasePathMappingsRequestRequestTypeDef#

# GetBasePathMappingsRequestRequestTypeDef definition

class GetBasePathMappingsRequestRequestTypeDef(TypedDict):
    domainName: str,
    domainNameId: NotRequired[str],
    position: NotRequired[str],
    limit: NotRequired[int],

GetClientCertificateRequestRequestTypeDef#

# GetClientCertificateRequestRequestTypeDef definition

class GetClientCertificateRequestRequestTypeDef(TypedDict):
    clientCertificateId: str,

GetClientCertificatesRequestRequestTypeDef#

# GetClientCertificatesRequestRequestTypeDef definition

class GetClientCertificatesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetDeploymentRequestRequestTypeDef#

# GetDeploymentRequestRequestTypeDef definition

class GetDeploymentRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: str,
    embed: NotRequired[Sequence[str]],

GetDeploymentsRequestRequestTypeDef#

# GetDeploymentsRequestRequestTypeDef definition

class GetDeploymentsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetDocumentationPartRequestRequestTypeDef#

# GetDocumentationPartRequestRequestTypeDef definition

class GetDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationPartId: str,

GetDocumentationPartsRequestRequestTypeDef#

# 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)
  1. See DocumentationPartTypeType
  2. See LocationStatusTypeType

GetDocumentationVersionRequestRequestTypeDef#

# GetDocumentationVersionRequestRequestTypeDef definition

class GetDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,

GetDocumentationVersionsRequestRequestTypeDef#

# GetDocumentationVersionsRequestRequestTypeDef definition

class GetDocumentationVersionsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetDomainNameAccessAssociationsRequestRequestTypeDef#

# GetDomainNameAccessAssociationsRequestRequestTypeDef definition

class GetDomainNameAccessAssociationsRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],
    resourceOwner: NotRequired[ResourceOwnerType],  # (1)
  1. See ResourceOwnerType

GetDomainNameRequestRequestTypeDef#

# GetDomainNameRequestRequestTypeDef definition

class GetDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,
    domainNameId: NotRequired[str],

GetDomainNamesRequestRequestTypeDef#

# GetDomainNamesRequestRequestTypeDef definition

class GetDomainNamesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],
    resourceOwner: NotRequired[ResourceOwnerType],  # (1)
  1. See ResourceOwnerType

GetExportRequestRequestTypeDef#

# GetExportRequestRequestTypeDef definition

class GetExportRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,
    exportType: str,
    parameters: NotRequired[Mapping[str, str]],
    accepts: NotRequired[str],

GetGatewayResponseRequestRequestTypeDef#

# GetGatewayResponseRequestRequestTypeDef definition

class GetGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
  1. See GatewayResponseTypeType

GetGatewayResponsesRequestRequestTypeDef#

# GetGatewayResponsesRequestRequestTypeDef definition

class GetGatewayResponsesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetIntegrationRequestRequestTypeDef#

# GetIntegrationRequestRequestTypeDef definition

class GetIntegrationRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

GetIntegrationResponseRequestRequestTypeDef#

# GetIntegrationResponseRequestRequestTypeDef definition

class GetIntegrationResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

GetMethodRequestRequestTypeDef#

# GetMethodRequestRequestTypeDef definition

class GetMethodRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,

GetMethodResponseRequestRequestTypeDef#

# GetMethodResponseRequestRequestTypeDef definition

class GetMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,

GetModelRequestRequestTypeDef#

# GetModelRequestRequestTypeDef definition

class GetModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,
    flatten: NotRequired[bool],

GetModelTemplateRequestRequestTypeDef#

# GetModelTemplateRequestRequestTypeDef definition

class GetModelTemplateRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,

GetModelsRequestRequestTypeDef#

# GetModelsRequestRequestTypeDef definition

class GetModelsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetRequestValidatorRequestRequestTypeDef#

# GetRequestValidatorRequestRequestTypeDef definition

class GetRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    requestValidatorId: str,

GetRequestValidatorsRequestRequestTypeDef#

# GetRequestValidatorsRequestRequestTypeDef definition

class GetRequestValidatorsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetResourceRequestRequestTypeDef#

# GetResourceRequestRequestTypeDef definition

class GetResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    embed: NotRequired[Sequence[str]],

GetResourcesRequestRequestTypeDef#

# GetResourcesRequestRequestTypeDef definition

class GetResourcesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    position: NotRequired[str],
    limit: NotRequired[int],
    embed: NotRequired[Sequence[str]],

GetRestApiRequestRequestTypeDef#

# GetRestApiRequestRequestTypeDef definition

class GetRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,

GetRestApisRequestRequestTypeDef#

# GetRestApisRequestRequestTypeDef definition

class GetRestApisRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetSdkRequestRequestTypeDef#

# GetSdkRequestRequestTypeDef definition

class GetSdkRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,
    sdkType: str,
    parameters: NotRequired[Mapping[str, str]],

GetSdkTypeRequestRequestTypeDef#

# GetSdkTypeRequestRequestTypeDef definition

class GetSdkTypeRequestRequestTypeDef(TypedDict):
    id: str,

GetSdkTypesRequestRequestTypeDef#

# GetSdkTypesRequestRequestTypeDef definition

class GetSdkTypesRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

GetStageRequestRequestTypeDef#

# GetStageRequestRequestTypeDef definition

class GetStageRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,

GetStagesRequestRequestTypeDef#

# GetStagesRequestRequestTypeDef definition

class GetStagesRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: NotRequired[str],

GetTagsRequestRequestTypeDef#

# GetTagsRequestRequestTypeDef definition

class GetTagsRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    position: NotRequired[str],
    limit: NotRequired[int],

GetUsagePlanKeyRequestRequestTypeDef#

# GetUsagePlanKeyRequestRequestTypeDef definition

class GetUsagePlanKeyRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,

GetUsagePlanKeysRequestRequestTypeDef#

# GetUsagePlanKeysRequestRequestTypeDef definition

class GetUsagePlanKeysRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    position: NotRequired[str],
    limit: NotRequired[int],
    nameQuery: NotRequired[str],

GetUsagePlanRequestRequestTypeDef#

# GetUsagePlanRequestRequestTypeDef definition

class GetUsagePlanRequestRequestTypeDef(TypedDict):
    usagePlanId: str,

GetUsagePlansRequestRequestTypeDef#

# GetUsagePlansRequestRequestTypeDef definition

class GetUsagePlansRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    keyId: NotRequired[str],
    limit: NotRequired[int],

GetUsageRequestRequestTypeDef#

# GetUsageRequestRequestTypeDef definition

class GetUsageRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    startDate: str,
    endDate: str,
    keyId: NotRequired[str],
    position: NotRequired[str],
    limit: NotRequired[int],

GetVpcLinkRequestRequestTypeDef#

# GetVpcLinkRequestRequestTypeDef definition

class GetVpcLinkRequestRequestTypeDef(TypedDict):
    vpcLinkId: str,

GetVpcLinksRequestRequestTypeDef#

# GetVpcLinksRequestRequestTypeDef definition

class GetVpcLinksRequestRequestTypeDef(TypedDict):
    position: NotRequired[str],
    limit: NotRequired[int],

IntegrationResponseTypeDef#

# 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)
  1. See ContentHandlingStrategyType

TlsConfigTypeDef#

# TlsConfigTypeDef definition

class TlsConfigTypeDef(TypedDict):
    insecureSkipVerification: NotRequired[bool],

MethodResponseTypeDef#

# MethodResponseTypeDef definition

class MethodResponseTypeDef(TypedDict):
    statusCode: NotRequired[str],
    responseParameters: NotRequired[Dict[str, bool]],
    responseModels: NotRequired[Dict[str, str]],

MethodSettingTypeDef#

# 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)
  1. See UnauthorizedCacheControlHeaderStrategyType

ModelTypeDef#

# ModelTypeDef definition

class ModelTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    schema: NotRequired[str],
    contentType: NotRequired[str],

PatchOperationTypeDef#

# PatchOperationTypeDef definition

class PatchOperationTypeDef(TypedDict):
    op: NotRequired[OpType],  # (1)
    path: NotRequired[str],
    value: NotRequired[str],
    from: NotRequired[str],
  1. See OpType

PutGatewayResponseRequestRequestTypeDef#

# PutGatewayResponseRequestRequestTypeDef definition

class PutGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
    statusCode: NotRequired[str],
    responseParameters: NotRequired[Mapping[str, str]],
    responseTemplates: NotRequired[Mapping[str, str]],
  1. See GatewayResponseTypeType

PutIntegrationResponseRequestRequestTypeDef#

# 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)
  1. See ContentHandlingStrategyType

PutMethodRequestRequestTypeDef#

# 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 definition

class PutMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    responseParameters: NotRequired[Mapping[str, bool]],
    responseModels: NotRequired[Mapping[str, str]],

RejectDomainNameAccessAssociationRequestRequestTypeDef#

# RejectDomainNameAccessAssociationRequestRequestTypeDef definition

class RejectDomainNameAccessAssociationRequestRequestTypeDef(TypedDict):
    domainNameAccessAssociationArn: str,
    domainNameArn: str,

RequestValidatorTypeDef#

# RequestValidatorTypeDef definition

class RequestValidatorTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    validateRequestBody: NotRequired[bool],
    validateRequestParameters: NotRequired[bool],

SdkConfigurationPropertyTypeDef#

# SdkConfigurationPropertyTypeDef definition

class SdkConfigurationPropertyTypeDef(TypedDict):
    name: NotRequired[str],
    friendlyName: NotRequired[str],
    description: NotRequired[str],
    required: NotRequired[bool],
    defaultValue: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

TestInvokeAuthorizerRequestRequestTypeDef#

# 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]],

TestInvokeMethodRequestRequestTypeDef#

# 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]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UsagePlanKeyTypeDef#

# UsagePlanKeyTypeDef definition

class UsagePlanKeyTypeDef(TypedDict):
    id: NotRequired[str],
    type: NotRequired[str],
    value: NotRequired[str],
    name: NotRequired[str],

VpcLinkTypeDef#

# 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]],
  1. See VpcLinkStatusType

ApiKeyIdsTypeDef#

# ApiKeyIdsTypeDef definition

class ApiKeyIdsTypeDef(TypedDict):
    ids: List[str],
    warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ApiKeyResponseTypeDef#

# ApiKeyResponseTypeDef definition

class ApiKeyResponseTypeDef(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)
  1. See ResponseMetadataTypeDef

AuthorizerResponseTypeDef#

# AuthorizerResponseTypeDef definition

class AuthorizerResponseTypeDef(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)
  1. See AuthorizerTypeType
  2. See ResponseMetadataTypeDef

BasePathMappingResponseTypeDef#

# BasePathMappingResponseTypeDef definition

class BasePathMappingResponseTypeDef(TypedDict):
    basePath: str,
    restApiId: str,
    stage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ClientCertificateResponseTypeDef#

# ClientCertificateResponseTypeDef definition

class ClientCertificateResponseTypeDef(TypedDict):
    clientCertificateId: str,
    description: str,
    pemEncodedCertificate: str,
    createdDate: datetime,
    expirationDate: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DocumentationPartIdsTypeDef#

# DocumentationPartIdsTypeDef definition

class DocumentationPartIdsTypeDef(TypedDict):
    ids: List[str],
    warnings: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DocumentationVersionResponseTypeDef#

# DocumentationVersionResponseTypeDef definition

class DocumentationVersionResponseTypeDef(TypedDict):
    version: str,
    createdDate: datetime,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DomainNameAccessAssociationResponseTypeDef#

# DomainNameAccessAssociationResponseTypeDef definition

class DomainNameAccessAssociationResponseTypeDef(TypedDict):
    domainNameAccessAssociationArn: str,
    domainNameArn: str,
    accessAssociationSourceType: AccessAssociationSourceTypeType,  # (1)
    accessAssociationSource: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessAssociationSourceTypeType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportResponseTypeDef#

# ExportResponseTypeDef definition

class ExportResponseTypeDef(TypedDict):
    contentType: str,
    contentDisposition: str,
    body: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GatewayResponseResponseTypeDef#

# GatewayResponseResponseTypeDef definition

class GatewayResponseResponseTypeDef(TypedDict):
    responseType: GatewayResponseTypeType,  # (1)
    statusCode: str,
    responseParameters: Dict[str, str],
    responseTemplates: Dict[str, str],
    defaultResponse: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GatewayResponseTypeType
  2. See ResponseMetadataTypeDef

IntegrationResponseResponseTypeDef#

# IntegrationResponseResponseTypeDef definition

class IntegrationResponseResponseTypeDef(TypedDict):
    statusCode: str,
    selectionPattern: str,
    responseParameters: Dict[str, str],
    responseTemplates: Dict[str, str],
    contentHandling: ContentHandlingStrategyType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ContentHandlingStrategyType
  2. See ResponseMetadataTypeDef

MethodResponseResponseTypeDef#

# MethodResponseResponseTypeDef definition

class MethodResponseResponseTypeDef(TypedDict):
    statusCode: str,
    responseParameters: Dict[str, bool],
    responseModels: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ModelResponseTypeDef#

# ModelResponseTypeDef definition

class ModelResponseTypeDef(TypedDict):
    id: str,
    name: str,
    description: str,
    schema: str,
    contentType: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RequestValidatorResponseTypeDef#

# RequestValidatorResponseTypeDef definition

class RequestValidatorResponseTypeDef(TypedDict):
    id: str,
    name: str,
    validateRequestBody: bool,
    validateRequestParameters: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SdkResponseTypeDef#

# SdkResponseTypeDef definition

class SdkResponseTypeDef(TypedDict):
    contentType: str,
    contentDisposition: str,
    body: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagsTypeDef#

# TagsTypeDef definition

class TagsTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TemplateTypeDef#

# TemplateTypeDef definition

class TemplateTypeDef(TypedDict):
    value: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestInvokeAuthorizerResponseTypeDef#

# 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)
  1. See ResponseMetadataTypeDef

TestInvokeMethodResponseTypeDef#

# 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)
  1. See ResponseMetadataTypeDef

UsagePlanKeyResponseTypeDef#

# UsagePlanKeyResponseTypeDef definition

class UsagePlanKeyResponseTypeDef(TypedDict):
    id: str,
    type: str,
    value: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UsageTypeDef#

# UsageTypeDef definition

class UsageTypeDef(TypedDict):
    usagePlanId: str,
    startDate: str,
    endDate: str,
    position: str,
    items: Dict[str, List[List[int]]],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

VpcLinkResponseTypeDef#

# VpcLinkResponseTypeDef definition

class VpcLinkResponseTypeDef(TypedDict):
    id: str,
    name: str,
    description: str,
    targetArns: List[str],
    status: VpcLinkStatusType,  # (1)
    statusMessage: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcLinkStatusType
  2. See ResponseMetadataTypeDef

AccountTypeDef#

# AccountTypeDef definition

class AccountTypeDef(TypedDict):
    cloudwatchRoleArn: str,
    throttleSettings: ThrottleSettingsTypeDef,  # (1)
    features: List[str],
    apiKeyVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ThrottleSettingsTypeDef
  2. See ResponseMetadataTypeDef

ApiStageOutputTypeDef#

# ApiStageOutputTypeDef definition

class ApiStageOutputTypeDef(TypedDict):
    apiId: NotRequired[str],
    stage: NotRequired[str],
    throttle: NotRequired[Dict[str, ThrottleSettingsTypeDef]],  # (1)
  1. See ThrottleSettingsTypeDef

ApiStageTypeDef#

# ApiStageTypeDef definition

class ApiStageTypeDef(TypedDict):
    apiId: NotRequired[str],
    stage: NotRequired[str],
    throttle: NotRequired[Mapping[str, ThrottleSettingsTypeDef]],  # (1)
  1. See ThrottleSettingsTypeDef

ApiKeysTypeDef#

# ApiKeysTypeDef definition

class ApiKeysTypeDef(TypedDict):
    warnings: List[str],
    position: str,
    items: List[ApiKeyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApiKeyTypeDef
  2. See ResponseMetadataTypeDef

AuthorizersTypeDef#

# AuthorizersTypeDef definition

class AuthorizersTypeDef(TypedDict):
    position: str,
    items: List[AuthorizerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthorizerTypeDef
  2. See ResponseMetadataTypeDef

BasePathMappingsTypeDef#

# BasePathMappingsTypeDef definition

class BasePathMappingsTypeDef(TypedDict):
    position: str,
    items: List[BasePathMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BasePathMappingTypeDef
  2. See ResponseMetadataTypeDef

ImportApiKeysRequestRequestTypeDef#

# ImportApiKeysRequestRequestTypeDef definition

class ImportApiKeysRequestRequestTypeDef(TypedDict):
    body: BlobTypeDef,
    format: ApiKeysFormatType,  # (1)
    failOnWarnings: NotRequired[bool],
  1. See ApiKeysFormatType

ImportDocumentationPartsRequestRequestTypeDef#

# ImportDocumentationPartsRequestRequestTypeDef definition

class ImportDocumentationPartsRequestRequestTypeDef(TypedDict):
    restApiId: str,
    body: BlobTypeDef,
    mode: NotRequired[PutModeType],  # (1)
    failOnWarnings: NotRequired[bool],
  1. See PutModeType

ImportRestApiRequestRequestTypeDef#

# ImportRestApiRequestRequestTypeDef definition

class ImportRestApiRequestRequestTypeDef(TypedDict):
    body: BlobTypeDef,
    failOnWarnings: NotRequired[bool],
    parameters: NotRequired[Mapping[str, str]],

PutRestApiRequestRequestTypeDef#

# PutRestApiRequestRequestTypeDef definition

class PutRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,
    body: BlobTypeDef,
    mode: NotRequired[PutModeType],  # (1)
    failOnWarnings: NotRequired[bool],
    parameters: NotRequired[Mapping[str, str]],
  1. See PutModeType

CreateStageRequestRequestTypeDef#

# 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]],
  1. See CacheClusterSizeType
  2. See CanarySettingsTypeDef

ClientCertificatesTypeDef#

# ClientCertificatesTypeDef definition

class ClientCertificatesTypeDef(TypedDict):
    position: str,
    items: List[ClientCertificateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClientCertificateTypeDef
  2. See ResponseMetadataTypeDef

CreateApiKeyRequestRequestTypeDef#

# 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]],
  1. See StageKeyTypeDef

CreateDeploymentRequestRequestTypeDef#

# 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],
  1. See CacheClusterSizeType
  2. See DeploymentCanarySettingsTypeDef

CreateDocumentationPartRequestRequestTypeDef#

# CreateDocumentationPartRequestRequestTypeDef definition

class CreateDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    location: DocumentationPartLocationTypeDef,  # (1)
    properties: str,
  1. See DocumentationPartLocationTypeDef

DocumentationPartResponseTypeDef#

# DocumentationPartResponseTypeDef definition

class DocumentationPartResponseTypeDef(TypedDict):
    id: str,
    location: DocumentationPartLocationTypeDef,  # (1)
    properties: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentationPartLocationTypeDef
  2. See ResponseMetadataTypeDef

DocumentationPartTypeDef#

# DocumentationPartTypeDef definition

class DocumentationPartTypeDef(TypedDict):
    id: NotRequired[str],
    location: NotRequired[DocumentationPartLocationTypeDef],  # (1)
    properties: NotRequired[str],
  1. See DocumentationPartLocationTypeDef

CreateRestApiRequestRequestTypeDef#

# 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],
  1. See ApiKeySourceTypeType
  2. See EndpointConfigurationTypeDef

CreateDomainNameRequestRequestTypeDef#

# 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],
    policy: NotRequired[str],
  1. See EndpointConfigurationTypeDef
  2. See SecurityPolicyType
  3. See MutualTlsAuthenticationInputTypeDef

DeploymentResponseTypeDef#

# DeploymentResponseTypeDef definition

class DeploymentResponseTypeDef(TypedDict):
    id: str,
    description: str,
    createdDate: datetime,
    apiSummary: Dict[str, Dict[str, MethodSnapshotTypeDef]],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MethodSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeploymentTypeDef#

# DeploymentTypeDef definition

class DeploymentTypeDef(TypedDict):
    id: NotRequired[str],
    description: NotRequired[str],
    createdDate: NotRequired[datetime],
    apiSummary: NotRequired[Dict[str, Dict[str, MethodSnapshotTypeDef]]],  # (1)
  1. See MethodSnapshotTypeDef

DocumentationVersionsTypeDef#

# DocumentationVersionsTypeDef definition

class DocumentationVersionsTypeDef(TypedDict):
    position: str,
    items: List[DocumentationVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentationVersionTypeDef
  2. See ResponseMetadataTypeDef

DomainNameAccessAssociationsTypeDef#

# DomainNameAccessAssociationsTypeDef definition

class DomainNameAccessAssociationsTypeDef(TypedDict):
    position: str,
    items: List[DomainNameAccessAssociationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameAccessAssociationTypeDef
  2. See ResponseMetadataTypeDef

RestApiResponseTypeDef#

# RestApiResponseTypeDef definition

class RestApiResponseTypeDef(TypedDict):
    id: str,
    name: str,
    description: str,
    createdDate: datetime,
    version: str,
    warnings: List[str],
    binaryMediaTypes: List[str],
    minimumCompressionSize: int,
    apiKeySource: ApiKeySourceTypeType,  # (1)
    endpointConfiguration: EndpointConfigurationOutputTypeDef,  # (2)
    policy: str,
    tags: Dict[str, str],
    disableExecuteApiEndpoint: bool,
    rootResourceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ApiKeySourceTypeType
  2. See EndpointConfigurationOutputTypeDef
  3. See ResponseMetadataTypeDef

RestApiTypeDef#

# 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[EndpointConfigurationOutputTypeDef],  # (2)
    policy: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    disableExecuteApiEndpoint: NotRequired[bool],
    rootResourceId: NotRequired[str],
  1. See ApiKeySourceTypeType
  2. See EndpointConfigurationOutputTypeDef

DomainNameResponseTypeDef#

# DomainNameResponseTypeDef definition

class DomainNameResponseTypeDef(TypedDict):
    domainName: str,
    domainNameId: str,
    domainNameArn: str,
    certificateName: str,
    certificateArn: str,
    certificateUploadDate: datetime,
    regionalDomainName: str,
    regionalHostedZoneId: str,
    regionalCertificateName: str,
    regionalCertificateArn: str,
    distributionDomainName: str,
    distributionHostedZoneId: str,
    endpointConfiguration: EndpointConfigurationOutputTypeDef,  # (1)
    domainNameStatus: DomainNameStatusType,  # (2)
    domainNameStatusMessage: str,
    securityPolicy: SecurityPolicyType,  # (3)
    tags: Dict[str, str],
    mutualTlsAuthentication: MutualTlsAuthenticationTypeDef,  # (4)
    ownershipVerificationCertificateArn: str,
    managementPolicy: str,
    policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See EndpointConfigurationOutputTypeDef
  2. See DomainNameStatusType
  3. See SecurityPolicyType
  4. See MutualTlsAuthenticationTypeDef
  5. See ResponseMetadataTypeDef

DomainNameTypeDef#

# DomainNameTypeDef definition

class DomainNameTypeDef(TypedDict):
    domainName: NotRequired[str],
    domainNameId: NotRequired[str],
    domainNameArn: 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[EndpointConfigurationOutputTypeDef],  # (1)
    domainNameStatus: NotRequired[DomainNameStatusType],  # (2)
    domainNameStatusMessage: NotRequired[str],
    securityPolicy: NotRequired[SecurityPolicyType],  # (3)
    tags: NotRequired[Dict[str, str]],
    mutualTlsAuthentication: NotRequired[MutualTlsAuthenticationTypeDef],  # (4)
    ownershipVerificationCertificateArn: NotRequired[str],
    managementPolicy: NotRequired[str],
    policy: NotRequired[str],
  1. See EndpointConfigurationOutputTypeDef
  2. See DomainNameStatusType
  3. See SecurityPolicyType
  4. See MutualTlsAuthenticationTypeDef

GatewayResponsesTypeDef#

# GatewayResponsesTypeDef definition

class GatewayResponsesTypeDef(TypedDict):
    position: str,
    items: List[GatewayResponseTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GatewayResponseTypeDef
  2. See ResponseMetadataTypeDef

GetApiKeysRequestGetApiKeysPaginateTypeDef#

# GetApiKeysRequestGetApiKeysPaginateTypeDef definition

class GetApiKeysRequestGetApiKeysPaginateTypeDef(TypedDict):
    nameQuery: NotRequired[str],
    customerId: NotRequired[str],
    includeValues: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetAuthorizersRequestGetAuthorizersPaginateTypeDef#

# GetAuthorizersRequestGetAuthorizersPaginateTypeDef definition

class GetAuthorizersRequestGetAuthorizersPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef#

# GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef definition

class GetBasePathMappingsRequestGetBasePathMappingsPaginateTypeDef(TypedDict):
    domainName: str,
    domainNameId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef#

# GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef definition

class GetClientCertificatesRequestGetClientCertificatesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetDeploymentsRequestGetDeploymentsPaginateTypeDef#

# GetDeploymentsRequestGetDeploymentsPaginateTypeDef definition

class GetDeploymentsRequestGetDeploymentsPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetDocumentationPartsRequestGetDocumentationPartsPaginateTypeDef#

# 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)
  1. See DocumentationPartTypeType
  2. See LocationStatusTypeType
  3. See PaginatorConfigTypeDef

GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef#

# GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef definition

class GetDocumentationVersionsRequestGetDocumentationVersionsPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetDomainNamesRequestGetDomainNamesPaginateTypeDef#

# GetDomainNamesRequestGetDomainNamesPaginateTypeDef definition

class GetDomainNamesRequestGetDomainNamesPaginateTypeDef(TypedDict):
    resourceOwner: NotRequired[ResourceOwnerType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ResourceOwnerType
  2. See PaginatorConfigTypeDef

GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef#

# GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef definition

class GetGatewayResponsesRequestGetGatewayResponsesPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetModelsRequestGetModelsPaginateTypeDef#

# GetModelsRequestGetModelsPaginateTypeDef definition

class GetModelsRequestGetModelsPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef#

# GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef definition

class GetRequestValidatorsRequestGetRequestValidatorsPaginateTypeDef(TypedDict):
    restApiId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetResourcesRequestGetResourcesPaginateTypeDef#

# GetResourcesRequestGetResourcesPaginateTypeDef definition

class GetResourcesRequestGetResourcesPaginateTypeDef(TypedDict):
    restApiId: str,
    embed: NotRequired[Sequence[str]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetRestApisRequestGetRestApisPaginateTypeDef#

# GetRestApisRequestGetRestApisPaginateTypeDef definition

class GetRestApisRequestGetRestApisPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetSdkTypesRequestGetSdkTypesPaginateTypeDef#

# GetSdkTypesRequestGetSdkTypesPaginateTypeDef definition

class GetSdkTypesRequestGetSdkTypesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef#

# GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef definition

class GetUsagePlanKeysRequestGetUsagePlanKeysPaginateTypeDef(TypedDict):
    usagePlanId: str,
    nameQuery: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetUsagePlansRequestGetUsagePlansPaginateTypeDef#

# GetUsagePlansRequestGetUsagePlansPaginateTypeDef definition

class GetUsagePlansRequestGetUsagePlansPaginateTypeDef(TypedDict):
    keyId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetUsageRequestGetUsagePaginateTypeDef#

# GetUsageRequestGetUsagePaginateTypeDef definition

class GetUsageRequestGetUsagePaginateTypeDef(TypedDict):
    usagePlanId: str,
    startDate: str,
    endDate: str,
    keyId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetVpcLinksRequestGetVpcLinksPaginateTypeDef#

# GetVpcLinksRequestGetVpcLinksPaginateTypeDef definition

class GetVpcLinksRequestGetVpcLinksPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

IntegrationExtraResponseTypeDef#

# IntegrationExtraResponseTypeDef definition

class IntegrationExtraResponseTypeDef(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)
  1. See IntegrationTypeType
  2. See ConnectionTypeType
  3. See ContentHandlingStrategyType
  4. See IntegrationResponseTypeDef
  5. See TlsConfigTypeDef
  6. See ResponseMetadataTypeDef

IntegrationTypeDef#

# 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)
  1. See IntegrationTypeType
  2. See ConnectionTypeType
  3. See ContentHandlingStrategyType
  4. See IntegrationResponseTypeDef
  5. See TlsConfigTypeDef

PutIntegrationRequestRequestTypeDef#

# 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)
  1. See IntegrationTypeType
  2. See ConnectionTypeType
  3. See ContentHandlingStrategyType
  4. See TlsConfigTypeDef

StageResponseTypeDef#

# StageResponseTypeDef definition

class StageResponseTypeDef(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: CanarySettingsOutputTypeDef,  # (5)
    tracingEnabled: bool,
    webAclArn: str,
    tags: Dict[str, str],
    createdDate: datetime,
    lastUpdatedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See CacheClusterSizeType
  2. See CacheClusterStatusType
  3. See MethodSettingTypeDef
  4. See AccessLogSettingsTypeDef
  5. See CanarySettingsOutputTypeDef
  6. See ResponseMetadataTypeDef

StageTypeDef#

# 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[CanarySettingsOutputTypeDef],  # (5)
    tracingEnabled: NotRequired[bool],
    webAclArn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    createdDate: NotRequired[datetime],
    lastUpdatedDate: NotRequired[datetime],
  1. See CacheClusterSizeType
  2. See CacheClusterStatusType
  3. See MethodSettingTypeDef
  4. See AccessLogSettingsTypeDef
  5. See CanarySettingsOutputTypeDef

ModelsTypeDef#

# ModelsTypeDef definition

class ModelsTypeDef(TypedDict):
    position: str,
    items: List[ModelTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelTypeDef
  2. See ResponseMetadataTypeDef

UpdateAccountRequestRequestTypeDef#

# UpdateAccountRequestRequestTypeDef definition

class UpdateAccountRequestRequestTypeDef(TypedDict):
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateApiKeyRequestRequestTypeDef#

# UpdateApiKeyRequestRequestTypeDef definition

class UpdateApiKeyRequestRequestTypeDef(TypedDict):
    apiKey: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateAuthorizerRequestRequestTypeDef#

# UpdateAuthorizerRequestRequestTypeDef definition

class UpdateAuthorizerRequestRequestTypeDef(TypedDict):
    restApiId: str,
    authorizerId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateBasePathMappingRequestRequestTypeDef#

# UpdateBasePathMappingRequestRequestTypeDef definition

class UpdateBasePathMappingRequestRequestTypeDef(TypedDict):
    domainName: str,
    basePath: str,
    domainNameId: NotRequired[str],
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateClientCertificateRequestRequestTypeDef#

# UpdateClientCertificateRequestRequestTypeDef definition

class UpdateClientCertificateRequestRequestTypeDef(TypedDict):
    clientCertificateId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateDeploymentRequestRequestTypeDef#

# UpdateDeploymentRequestRequestTypeDef definition

class UpdateDeploymentRequestRequestTypeDef(TypedDict):
    restApiId: str,
    deploymentId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateDocumentationPartRequestRequestTypeDef#

# UpdateDocumentationPartRequestRequestTypeDef definition

class UpdateDocumentationPartRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationPartId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateDocumentationVersionRequestRequestTypeDef#

# UpdateDocumentationVersionRequestRequestTypeDef definition

class UpdateDocumentationVersionRequestRequestTypeDef(TypedDict):
    restApiId: str,
    documentationVersion: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateDomainNameRequestRequestTypeDef#

# UpdateDomainNameRequestRequestTypeDef definition

class UpdateDomainNameRequestRequestTypeDef(TypedDict):
    domainName: str,
    domainNameId: NotRequired[str],
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateGatewayResponseRequestRequestTypeDef#

# UpdateGatewayResponseRequestRequestTypeDef definition

class UpdateGatewayResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    responseType: GatewayResponseTypeType,  # (1)
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (2)
  1. See GatewayResponseTypeType
  2. See PatchOperationTypeDef

UpdateIntegrationRequestRequestTypeDef#

# UpdateIntegrationRequestRequestTypeDef definition

class UpdateIntegrationRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateIntegrationResponseRequestRequestTypeDef#

# UpdateIntegrationResponseRequestRequestTypeDef definition

class UpdateIntegrationResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateMethodRequestRequestTypeDef#

# UpdateMethodRequestRequestTypeDef definition

class UpdateMethodRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateMethodResponseRequestRequestTypeDef#

# UpdateMethodResponseRequestRequestTypeDef definition

class UpdateMethodResponseRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    httpMethod: str,
    statusCode: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateModelRequestRequestTypeDef#

# UpdateModelRequestRequestTypeDef definition

class UpdateModelRequestRequestTypeDef(TypedDict):
    restApiId: str,
    modelName: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateRequestValidatorRequestRequestTypeDef#

# UpdateRequestValidatorRequestRequestTypeDef definition

class UpdateRequestValidatorRequestRequestTypeDef(TypedDict):
    restApiId: str,
    requestValidatorId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateResourceRequestRequestTypeDef#

# UpdateResourceRequestRequestTypeDef definition

class UpdateResourceRequestRequestTypeDef(TypedDict):
    restApiId: str,
    resourceId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateRestApiRequestRequestTypeDef#

# UpdateRestApiRequestRequestTypeDef definition

class UpdateRestApiRequestRequestTypeDef(TypedDict):
    restApiId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateStageRequestRequestTypeDef#

# UpdateStageRequestRequestTypeDef definition

class UpdateStageRequestRequestTypeDef(TypedDict):
    restApiId: str,
    stageName: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateUsagePlanRequestRequestTypeDef#

# UpdateUsagePlanRequestRequestTypeDef definition

class UpdateUsagePlanRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateUsageRequestRequestTypeDef#

# UpdateUsageRequestRequestTypeDef definition

class UpdateUsageRequestRequestTypeDef(TypedDict):
    usagePlanId: str,
    keyId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

UpdateVpcLinkRequestRequestTypeDef#

# UpdateVpcLinkRequestRequestTypeDef definition

class UpdateVpcLinkRequestRequestTypeDef(TypedDict):
    vpcLinkId: str,
    patchOperations: NotRequired[Sequence[PatchOperationTypeDef]],  # (1)
  1. See PatchOperationTypeDef

RequestValidatorsTypeDef#

# RequestValidatorsTypeDef definition

class RequestValidatorsTypeDef(TypedDict):
    position: str,
    items: List[RequestValidatorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RequestValidatorTypeDef
  2. See ResponseMetadataTypeDef

SdkTypeResponseTypeDef#

# SdkTypeResponseTypeDef definition

class SdkTypeResponseTypeDef(TypedDict):
    id: str,
    friendlyName: str,
    description: str,
    configurationProperties: List[SdkConfigurationPropertyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SdkConfigurationPropertyTypeDef
  2. See ResponseMetadataTypeDef

SdkTypeTypeDef#

# SdkTypeTypeDef definition

class SdkTypeTypeDef(TypedDict):
    id: NotRequired[str],
    friendlyName: NotRequired[str],
    description: NotRequired[str],
    configurationProperties: NotRequired[List[SdkConfigurationPropertyTypeDef]],  # (1)
  1. See SdkConfigurationPropertyTypeDef

UsagePlanKeysTypeDef#

# UsagePlanKeysTypeDef definition

class UsagePlanKeysTypeDef(TypedDict):
    position: str,
    items: List[UsagePlanKeyTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UsagePlanKeyTypeDef
  2. See ResponseMetadataTypeDef

VpcLinksTypeDef#

# VpcLinksTypeDef definition

class VpcLinksTypeDef(TypedDict):
    position: str,
    items: List[VpcLinkTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VpcLinkTypeDef
  2. See ResponseMetadataTypeDef

UsagePlanResponseTypeDef#

# UsagePlanResponseTypeDef definition

class UsagePlanResponseTypeDef(TypedDict):
    id: str,
    name: str,
    description: str,
    apiStages: List[ApiStageOutputTypeDef],  # (1)
    throttle: ThrottleSettingsTypeDef,  # (2)
    quota: QuotaSettingsTypeDef,  # (3)
    productCode: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ApiStageOutputTypeDef
  2. See ThrottleSettingsTypeDef
  3. See QuotaSettingsTypeDef
  4. See ResponseMetadataTypeDef

UsagePlanTypeDef#

# UsagePlanTypeDef definition

class UsagePlanTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    apiStages: NotRequired[List[ApiStageOutputTypeDef]],  # (1)
    throttle: NotRequired[ThrottleSettingsTypeDef],  # (2)
    quota: NotRequired[QuotaSettingsTypeDef],  # (3)
    productCode: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See ApiStageOutputTypeDef
  2. See ThrottleSettingsTypeDef
  3. See QuotaSettingsTypeDef

DocumentationPartsTypeDef#

# DocumentationPartsTypeDef definition

class DocumentationPartsTypeDef(TypedDict):
    position: str,
    items: List[DocumentationPartTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentationPartTypeDef
  2. See ResponseMetadataTypeDef

DeploymentsTypeDef#

# DeploymentsTypeDef definition

class DeploymentsTypeDef(TypedDict):
    position: str,
    items: List[DeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeploymentTypeDef
  2. See ResponseMetadataTypeDef

RestApisTypeDef#

# RestApisTypeDef definition

class RestApisTypeDef(TypedDict):
    position: str,
    items: List[RestApiTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RestApiTypeDef
  2. See ResponseMetadataTypeDef

DomainNamesTypeDef#

# DomainNamesTypeDef definition

class DomainNamesTypeDef(TypedDict):
    position: str,
    items: List[DomainNameTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainNameTypeDef
  2. See ResponseMetadataTypeDef

MethodExtraResponseTypeDef#

# MethodExtraResponseTypeDef definition

class MethodExtraResponseTypeDef(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)
  1. See MethodResponseTypeDef
  2. See IntegrationTypeDef
  3. See ResponseMetadataTypeDef

MethodTypeDef#

# MethodTypeDef definition

class MethodTypeDef(TypedDict):
    httpMethod: NotRequired[str],
    authorizationType: NotRequired[str],
    authorizerId: NotRequired[str],
    apiKeyRequired: NotRequired[bool],
    requestValidatorId: NotRequired[str],
    operationName: NotRequired[str],
    requestParameters: NotRequired[Dict[str, bool]],
    requestModels: NotRequired[Dict[str, str]],
    methodResponses: NotRequired[Dict[str, MethodResponseTypeDef]],  # (1)
    methodIntegration: NotRequired[IntegrationTypeDef],  # (2)
    authorizationScopes: NotRequired[List[str]],
  1. See MethodResponseTypeDef
  2. See IntegrationTypeDef

StagesTypeDef#

# StagesTypeDef definition

class StagesTypeDef(TypedDict):
    item: List[StageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StageTypeDef
  2. See ResponseMetadataTypeDef

SdkTypesTypeDef#

# SdkTypesTypeDef definition

class SdkTypesTypeDef(TypedDict):
    position: str,
    items: List[SdkTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SdkTypeTypeDef
  2. See ResponseMetadataTypeDef

UsagePlansTypeDef#

# UsagePlansTypeDef definition

class UsagePlansTypeDef(TypedDict):
    position: str,
    items: List[UsagePlanTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UsagePlanTypeDef
  2. See ResponseMetadataTypeDef

CreateUsagePlanRequestRequestTypeDef#

# CreateUsagePlanRequestRequestTypeDef definition

class CreateUsagePlanRequestRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],
    apiStages: NotRequired[Sequence[ApiStageUnionTypeDef]],  # (1)
    throttle: NotRequired[ThrottleSettingsTypeDef],  # (2)
    quota: NotRequired[QuotaSettingsTypeDef],  # (3)
    tags: NotRequired[Mapping[str, str]],
  1. See ApiStageTypeDef ApiStageOutputTypeDef
  2. See ThrottleSettingsTypeDef
  3. See QuotaSettingsTypeDef

ResourceResponseTypeDef#

# ResourceResponseTypeDef definition

class ResourceResponseTypeDef(TypedDict):
    id: str,
    parentId: str,
    pathPart: str,
    path: str,
    resourceMethods: Dict[str, MethodTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MethodTypeDef
  2. See ResponseMetadataTypeDef

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    id: NotRequired[str],
    parentId: NotRequired[str],
    pathPart: NotRequired[str],
    path: NotRequired[str],
    resourceMethods: NotRequired[Dict[str, MethodTypeDef]],  # (1)
  1. See MethodTypeDef

ResourcesTypeDef#

# ResourcesTypeDef definition

class ResourcesTypeDef(TypedDict):
    position: str,
    items: List[ResourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceTypeDef
  2. See ResponseMetadataTypeDef