Apigateway Classes

AccessLogSettings

format

• Type: typing.Optional[str]

destinationArn

• Type: typing.Optional[str]

Account

cloudwatchRoleArn

• Type:
• Required: Yes

throttleSettings

• Type:
• Required: Yes

features

• Type: typing.List[str]
• Required: Yes

apiKeyVersion

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ApiKey

id

• Type: typing.Optional[str]

value

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

customerId

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

enabled

• Type: typing.Optional[bool]

createdDate

• Type: typing.Optional[datetime.datetime]

lastUpdatedDate

• Type: typing.Optional[datetime.datetime]

stageKeys

• Type: typing.Optional[typing.List[str]]

tags

• Type: typing.Optional[typing.Dict[str, str]]

ApiKeyIds

ids

• Type: typing.List[str]
• Required: Yes

warnings

• Type: typing.List[str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ApiKeyResponse

id

• Type:
• Required: Yes

value

• Type:
• Required: Yes

name

• Type:
• Required: Yes

customerId

• Type:
• Required: Yes

description

• Type:
• Required: Yes

enabled

• Type:
• Required: Yes

createdDate

• Type:
• Required: Yes

lastUpdatedDate

• Type:
• Required: Yes

stageKeys

• Type: typing.List[str]
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ApiKeys

warnings

• Type: typing.List[str]
• Required: Yes

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ApiKey]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ApiStage

apiId

• Type: typing.Optional[str]

stage

• Type: typing.Optional[str]

throttle

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ThrottleSettings]]

ApiStageOutput

apiId

• Type: typing.Optional[str]

stage

• Type: typing.Optional[str]

throttle

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ThrottleSettings]]

Authorizer

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

type

• Type: typing.Optional[typing.Literal['COGNITO_USER_POOLS', 'REQUEST', 'TOKEN']]

providerARNs

• Type: typing.Optional[typing.List[str]]

authType

• Type: typing.Optional[str]

authorizerUri

• Type: typing.Optional[str]

authorizerCredentials

• Type: typing.Optional[str]

identitySource

• Type: typing.Optional[str]

identityValidationExpression

• Type: typing.Optional[str]

authorizerResultTtlInSeconds

• Type: typing.Optional[int]

AuthorizerResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

type

• Type: typing.Literal['COGNITO_USER_POOLS', 'REQUEST', 'TOKEN']
• Required: Yes

providerARNs

• Type: typing.List[str]
• Required: Yes

authType

• Type:
• Required: Yes

authorizerUri

• Type:
• Required: Yes

authorizerCredentials

• Type:
• Required: Yes

identitySource

• Type:
• Required: Yes

identityValidationExpression

• Type:
• Required: Yes

authorizerResultTtlInSeconds

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Authorizers

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Authorizer]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

BasePathMapping

basePath

• Type: typing.Optional[str]

restApiId

• Type: typing.Optional[str]

stage

• Type: typing.Optional[str]

BasePathMappingResponse

basePath

• Type:
• Required: Yes

restApiId

• Type:
• Required: Yes

stage

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

BasePathMappings

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.BasePathMapping]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CanarySettings

percentTraffic

• Type: typing.Optional[float]

deploymentId

• Type: typing.Optional[str]

stageVariableOverrides

• Type: typing.Optional[typing.Dict[str, str]]

useStageCache

• Type: typing.Optional[bool]

CanarySettingsOutput

percentTraffic

• Type: typing.Optional[float]

deploymentId

• Type: typing.Optional[str]

stageVariableOverrides

• Type: typing.Optional[typing.Dict[str, str]]

useStageCache

• Type: typing.Optional[bool]

ClientCertificate

clientCertificateId

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

pemEncodedCertificate

• Type: typing.Optional[str]

createdDate

• Type: typing.Optional[datetime.datetime]

expirationDate

• Type: typing.Optional[datetime.datetime]

tags

• Type: typing.Optional[typing.Dict[str, str]]

ClientCertificateResponse

clientCertificateId

• Type:
• Required: Yes

description

• Type:
• Required: Yes

pemEncodedCertificate

• Type:
• Required: Yes

createdDate

• Type:
• Required: Yes

expirationDate

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ClientCertificates

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ClientCertificate]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateApiKeyRequest

name

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

enabled

• Type: typing.Optional[bool]

generateDistinctId

• Type: typing.Optional[bool]

value

• Type: typing.Optional[str]

stageKeys

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.StageKey]]

customerId

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

CreateAuthorizerRequest

restApiId

• Type:
• Required: Yes

name

• Type:
• Required: Yes

type

• Type: typing.Literal['COGNITO_USER_POOLS', 'REQUEST', 'TOKEN']
• Required: Yes

providerARNs

• Type: typing.Optional[typing.List[str]]

authType

• Type: typing.Optional[str]

authorizerUri

• Type: typing.Optional[str]

authorizerCredentials

• Type: typing.Optional[str]

identitySource

• Type: typing.Optional[str]

identityValidationExpression

• Type: typing.Optional[str]

authorizerResultTtlInSeconds

• Type: typing.Optional[int]

CreateBasePathMappingRequest

domainName

• Type:
• Required: Yes

restApiId

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

basePath

• Type: typing.Optional[str]

stage

• Type: typing.Optional[str]

CreateDeploymentRequest

restApiId

• Type:
• Required: Yes

stageName

• Type: typing.Optional[str]

stageDescription

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

cacheClusterEnabled

• Type: typing.Optional[bool]

cacheClusterSize

• Type: typing.Optional[typing.Literal['0.5', '1.6', '118', '13.5', '237', '28.4', '58.2', '6.1']]

variables

• Type: typing.Optional[typing.Dict[str, str]]

canarySettings

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DeploymentCanarySettings]

tracingEnabled

• Type: typing.Optional[bool]

CreateDocumentationPartRequest

restApiId

• Type:
• Required: Yes

location

• Type:
• Required: Yes

properties

• Type:
• Required: Yes

CreateDocumentationVersionRequest

restApiId

• Type:
• Required: Yes

documentationVersion

• Type:
• Required: Yes

stageName

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

CreateDomainNameAccessAssociationRequest

domainNameArn

• Type:
• Required: Yes

accessAssociationSourceType

• Type: typing.Literal['VPCE']
• Required: Yes

accessAssociationSource

• Type:
• Required: Yes

tags

• Type: typing.Optional[typing.Dict[str, str]]

CreateDomainNameRequest

domainName

• Type:
• Required: Yes

certificateName

• Type: typing.Optional[str]

certificateBody

• Type: typing.Optional[str]

certificatePrivateKey

• Type: typing.Optional[str]

certificateChain

• Type: typing.Optional[str]

certificateArn

• Type: typing.Optional[str]

regionalCertificateName

• Type: typing.Optional[str]

regionalCertificateArn

• Type: typing.Optional[str]

endpointConfiguration

• Type: typing.Union[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfiguration, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfigurationOutput, NoneType]

tags

• Type: typing.Optional[typing.Dict[str, str]]

securityPolicy

• Type: typing.Optional[typing.Literal['TLS_1_0', 'TLS_1_2']]

mutualTlsAuthentication

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MutualTlsAuthenticationInput]

ownershipVerificationCertificateArn

• Type: typing.Optional[str]

policy

• Type: typing.Optional[str]

CreateModelRequest

restApiId

• Type:
• Required: Yes

name

• Type:
• Required: Yes

contentType

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

schema

• Type: typing.Optional[str]

CreateRequestValidatorRequest

restApiId

• Type:
• Required: Yes

name

• Type: typing.Optional[str]

validateRequestBody

• Type: typing.Optional[bool]

validateRequestParameters

• Type: typing.Optional[bool]

CreateResourceRequest

restApiId

• Type:
• Required: Yes

parentId

• Type:
• Required: Yes

pathPart

• Type:
• Required: Yes

CreateRestApiRequest

name

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

version

• Type: typing.Optional[str]

cloneFrom

• Type: typing.Optional[str]

binaryMediaTypes

• Type: typing.Optional[typing.List[str]]

minimumCompressionSize

• Type: typing.Optional[int]

apiKeySource

• Type: typing.Optional[typing.Literal['AUTHORIZER', 'HEADER']]

endpointConfiguration

• Type: typing.Union[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfiguration, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfigurationOutput, NoneType]

policy

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

disableExecuteApiEndpoint

• Type: typing.Optional[bool]

CreateStageRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

deploymentId

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

cacheClusterEnabled

• Type: typing.Optional[bool]

cacheClusterSize

• Type: typing.Optional[typing.Literal['0.5', '1.6', '118', '13.5', '237', '28.4', '58.2', '6.1']]

variables

• Type: typing.Optional[typing.Dict[str, str]]

documentationVersion

• Type: typing.Optional[str]

canarySettings

• Type: typing.Union[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.CanarySettings, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.CanarySettingsOutput, NoneType]

tracingEnabled

• Type: typing.Optional[bool]

tags

• Type: typing.Optional[typing.Dict[str, str]]

CreateUsagePlanKeyRequest

usagePlanId

• Type:
• Required: Yes

keyId

• Type:
• Required: Yes

keyType

• Type:
• Required: Yes

CreateUsagePlanRequest

name

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

apiStages

• Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ApiStage, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ApiStageOutput]]]

throttle

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ThrottleSettings]

quota

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.QuotaSettings]

tags

• Type: typing.Optional[typing.Dict[str, str]]

CreateVpcLinkRequest

name

• Type:
• Required: Yes

targetArns

• Type: typing.List[str]
• Required: Yes

description

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

DeleteApiKeyRequest

apiKey

• Type:
• Required: Yes

DeleteAuthorizerRequest

restApiId

• Type:
• Required: Yes

authorizerId

• Type:
• Required: Yes

DeleteBasePathMappingRequest

domainName

• Type:
• Required: Yes

basePath

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

DeleteClientCertificateRequest

clientCertificateId

• Type:
• Required: Yes

DeleteDeploymentRequest

restApiId

• Type:
• Required: Yes

deploymentId

• Type:
• Required: Yes

DeleteDocumentationPartRequest

restApiId

• Type:
• Required: Yes

documentationPartId

• Type:
• Required: Yes

DeleteDocumentationVersionRequest

restApiId

• Type:
• Required: Yes

documentationVersion

• Type:
• Required: Yes

DeleteDomainNameAccessAssociationRequest

domainNameAccessAssociationArn

• Type:
• Required: Yes

DeleteDomainNameRequest

domainName

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

DeleteGatewayResponseRequest

restApiId

• Type:
• Required: Yes

responseType

• Type: typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']
• Required: Yes

DeleteIntegrationRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

DeleteIntegrationResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

DeleteMethodRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

DeleteMethodResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

DeleteModelRequest

restApiId

• Type:
• Required: Yes

modelName

• Type:
• Required: Yes

DeleteRequestValidatorRequest

restApiId

• Type:
• Required: Yes

requestValidatorId

• Type:
• Required: Yes

DeleteResourceRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

DeleteRestApiRequest

restApiId

• Type:
• Required: Yes

DeleteStageRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

DeleteUsagePlanKeyRequest

usagePlanId

• Type:
• Required: Yes

keyId

• Type:
• Required: Yes

DeleteUsagePlanRequest

usagePlanId

• Type:
• Required: Yes

DeleteVpcLinkRequest

vpcLinkId

• Type:
• Required: Yes

Deployment

id

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

createdDate

• Type: typing.Optional[datetime.datetime]

apiSummary

• Type: typing.Optional[typing.Dict[str, typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodSnapshot]]]

DeploymentCanarySettings

percentTraffic

• Type: typing.Optional[float]

stageVariableOverrides

• Type: typing.Optional[typing.Dict[str, str]]

useStageCache

• Type: typing.Optional[bool]

DeploymentResponse

id

• Type:
• Required: Yes

description

• Type:
• Required: Yes

createdDate

• Type:
• Required: Yes

apiSummary

• Type: typing.Dict[str, typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodSnapshot]]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Deployments

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Deployment]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DocumentationPart

id

• Type: typing.Optional[str]

location

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DocumentationPartLocation]

properties

• Type: typing.Optional[str]

DocumentationPartIds

ids

• Type: typing.List[str]
• Required: Yes

warnings

• Type: typing.List[str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DocumentationPartLocation

type

• Type: typing.Literal['API', 'AUTHORIZER', 'METHOD', 'MODEL', 'PATH_PARAMETER', 'QUERY_PARAMETER', 'REQUEST_BODY', 'REQUEST_HEADER', 'RESOURCE', 'RESPONSE', 'RESPONSE_BODY', 'RESPONSE_HEADER']
• Required: Yes

path

• Type: typing.Optional[str]

method

• Type: typing.Optional[str]

statusCode

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

DocumentationPartResponse

id

• Type:
• Required: Yes

location

• Type:
• Required: Yes

properties

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DocumentationParts

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DocumentationPart]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DocumentationVersion

version

• Type: typing.Optional[str]

createdDate

• Type: typing.Optional[datetime.datetime]

description

• Type: typing.Optional[str]

DocumentationVersionResponse

version

• Type:
• Required: Yes

createdDate

• Type:
• Required: Yes

description

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DocumentationVersions

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DocumentationVersion]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DomainName

domainName

• Type: typing.Optional[str]

domainNameId

• Type: typing.Optional[str]

domainNameArn

• Type: typing.Optional[str]

certificateName

• Type: typing.Optional[str]

certificateArn

• Type: typing.Optional[str]

certificateUploadDate

• Type: typing.Optional[datetime.datetime]

regionalDomainName

• Type: typing.Optional[str]

regionalHostedZoneId

• Type: typing.Optional[str]

regionalCertificateName

• Type: typing.Optional[str]

regionalCertificateArn

• Type: typing.Optional[str]

distributionDomainName

• Type: typing.Optional[str]

distributionHostedZoneId

• Type: typing.Optional[str]

endpointConfiguration

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfigurationOutput]

domainNameStatus

• Type: typing.Optional[typing.Literal['AVAILABLE', 'PENDING', 'PENDING_CERTIFICATE_REIMPORT', 'PENDING_OWNERSHIP_VERIFICATION', 'UPDATING']]

domainNameStatusMessage

• Type: typing.Optional[str]

securityPolicy

• Type: typing.Optional[typing.Literal['TLS_1_0', 'TLS_1_2']]

tags

• Type: typing.Optional[typing.Dict[str, str]]

mutualTlsAuthentication

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MutualTlsAuthentication]

ownershipVerificationCertificateArn

• Type: typing.Optional[str]

managementPolicy

• Type: typing.Optional[str]

policy

• Type: typing.Optional[str]

DomainNameAccessAssociation

domainNameAccessAssociationArn

• Type: typing.Optional[str]

domainNameArn

• Type: typing.Optional[str]

accessAssociationSourceType

• Type: typing.Optional[typing.Literal['VPCE']]

accessAssociationSource

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

DomainNameAccessAssociationResponse

domainNameAccessAssociationArn

• Type:
• Required: Yes

domainNameArn

• Type:
• Required: Yes

accessAssociationSourceType

• Type: typing.Literal['VPCE']
• Required: Yes

accessAssociationSource

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DomainNameAccessAssociations

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DomainNameAccessAssociation]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DomainNameResponse

domainName

• Type:
• Required: Yes

domainNameId

• Type:
• Required: Yes

domainNameArn

• Type:
• Required: Yes

certificateName

• Type:
• Required: Yes

certificateArn

• Type:
• Required: Yes

certificateUploadDate

• Type:
• Required: Yes

regionalDomainName

• Type:
• Required: Yes

regionalHostedZoneId

• Type:
• Required: Yes

regionalCertificateName

• Type:
• Required: Yes

regionalCertificateArn

• Type:
• Required: Yes

distributionDomainName

• Type:
• Required: Yes

distributionHostedZoneId

• Type:
• Required: Yes

endpointConfiguration

• Type:
• Required: Yes

domainNameStatus

• Type: typing.Literal['AVAILABLE', 'PENDING', 'PENDING_CERTIFICATE_REIMPORT', 'PENDING_OWNERSHIP_VERIFICATION', 'UPDATING']
• Required: Yes

domainNameStatusMessage

• Type:
• Required: Yes

securityPolicy

• Type: typing.Literal['TLS_1_0', 'TLS_1_2']
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

mutualTlsAuthentication

• Type:
• Required: Yes

ownershipVerificationCertificateArn

• Type:
• Required: Yes

managementPolicy

• Type:
• Required: Yes

policy

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DomainNames

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.DomainName]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

EmptyResponseMetadata

ResponseMetadata

• Type:
• Required: Yes

EndpointConfiguration

types

• Type: typing.Optional[typing.List[typing.Literal['EDGE', 'PRIVATE', 'REGIONAL']]]

vpcEndpointIds

• Type: typing.Optional[typing.List[str]]

EndpointConfigurationOutput

types

• Type: typing.Optional[typing.List[typing.Literal['EDGE', 'PRIVATE', 'REGIONAL']]]

vpcEndpointIds

• Type: typing.Optional[typing.List[str]]

ExportResponse

contentType

• Type:
• Required: Yes

contentDisposition

• Type:
• Required: Yes

body

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

FlushStageAuthorizersCacheRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

FlushStageCacheRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

GatewayResponse

responseType

• Type: typing.Optional[typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']]

statusCode

• Type: typing.Optional[str]

responseParameters

• Type: typing.Optional[typing.Dict[str, str]]

responseTemplates

• Type: typing.Optional[typing.Dict[str, str]]

defaultResponse

• Type: typing.Optional[bool]

GatewayResponseResponse

responseType

• Type: typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']
• Required: Yes

statusCode

• Type:
• Required: Yes

responseParameters

• Type: typing.Dict[str, str]
• Required: Yes

responseTemplates

• Type: typing.Dict[str, str]
• Required: Yes

defaultResponse

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GatewayResponses

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.GatewayResponse]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GenerateClientCertificateRequest

description

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

GetApiKeyRequest

apiKey

• Type:
• Required: Yes

includeValue

• Type: typing.Optional[bool]

GetApiKeysRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

nameQuery

• Type: typing.Optional[str]

customerId

• Type: typing.Optional[str]

includeValues

• Type: typing.Optional[bool]

GetApiKeysRequestPaginate

nameQuery

• Type: typing.Optional[str]

customerId

• Type: typing.Optional[str]

includeValues

• Type: typing.Optional[bool]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetAuthorizerRequest

restApiId

• Type:
• Required: Yes

authorizerId

• Type:
• Required: Yes

GetAuthorizersRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetAuthorizersRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetBasePathMappingRequest

domainName

• Type:
• Required: Yes

basePath

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

GetBasePathMappingsRequest

domainName

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetBasePathMappingsRequestPaginate

domainName

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetClientCertificateRequest

clientCertificateId

• Type:
• Required: Yes

GetClientCertificatesRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetClientCertificatesRequestPaginate

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetDeploymentRequest

restApiId

• Type:
• Required: Yes

deploymentId

• Type:
• Required: Yes

embed

• Type: typing.Optional[typing.List[str]]

GetDeploymentsRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetDeploymentsRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetDocumentationPartRequest

restApiId

• Type:
• Required: Yes

documentationPartId

• Type:
• Required: Yes

GetDocumentationPartsRequest

restApiId

• Type:
• Required: Yes

type

• Type: typing.Optional[typing.Literal['API', 'AUTHORIZER', 'METHOD', 'MODEL', 'PATH_PARAMETER', 'QUERY_PARAMETER', 'REQUEST_BODY', 'REQUEST_HEADER', 'RESOURCE', 'RESPONSE', 'RESPONSE_BODY', 'RESPONSE_HEADER']]

nameQuery

• Type: typing.Optional[str]

path

• Type: typing.Optional[str]

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

locationStatus

• Type: typing.Optional[typing.Literal['DOCUMENTED', 'UNDOCUMENTED']]

GetDocumentationPartsRequestPaginate

restApiId

• Type:
• Required: Yes

type

• Type: typing.Optional[typing.Literal['API', 'AUTHORIZER', 'METHOD', 'MODEL', 'PATH_PARAMETER', 'QUERY_PARAMETER', 'REQUEST_BODY', 'REQUEST_HEADER', 'RESOURCE', 'RESPONSE', 'RESPONSE_BODY', 'RESPONSE_HEADER']]

nameQuery

• Type: typing.Optional[str]

path

• Type: typing.Optional[str]

locationStatus

• Type: typing.Optional[typing.Literal['DOCUMENTED', 'UNDOCUMENTED']]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetDocumentationVersionRequest

restApiId

• Type:
• Required: Yes

documentationVersion

• Type:
• Required: Yes

GetDocumentationVersionsRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetDocumentationVersionsRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetDomainNameAccessAssociationsRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

resourceOwner

• Type: typing.Optional[typing.Literal['OTHER_ACCOUNTS', 'SELF']]

GetDomainNameRequest

domainName

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

GetDomainNamesRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

resourceOwner

• Type: typing.Optional[typing.Literal['OTHER_ACCOUNTS', 'SELF']]

GetDomainNamesRequestPaginate

resourceOwner

• Type: typing.Optional[typing.Literal['OTHER_ACCOUNTS', 'SELF']]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetExportRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

exportType

• Type:
• Required: Yes

parameters

• Type: typing.Optional[typing.Dict[str, str]]

accepts

• Type: typing.Optional[str]

GetGatewayResponseRequest

restApiId

• Type:
• Required: Yes

responseType

• Type: typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']
• Required: Yes

GetGatewayResponsesRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetGatewayResponsesRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetIntegrationRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

GetIntegrationResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

GetMethodRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

GetMethodResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

GetModelRequest

restApiId

• Type:
• Required: Yes

modelName

• Type:
• Required: Yes

flatten

• Type: typing.Optional[bool]

GetModelTemplateRequest

restApiId

• Type:
• Required: Yes

modelName

• Type:
• Required: Yes

GetModelsRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetModelsRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetRequestValidatorRequest

restApiId

• Type:
• Required: Yes

requestValidatorId

• Type:
• Required: Yes

GetRequestValidatorsRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetRequestValidatorsRequestPaginate

restApiId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetResourceRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

embed

• Type: typing.Optional[typing.List[str]]

GetResourcesRequest

restApiId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

embed

• Type: typing.Optional[typing.List[str]]

GetResourcesRequestPaginate

restApiId

• Type:
• Required: Yes

embed

• Type: typing.Optional[typing.List[str]]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetRestApiRequest

restApiId

• Type:
• Required: Yes

GetRestApisRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetRestApisRequestPaginate

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetSdkRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

sdkType

• Type:
• Required: Yes

parameters

• Type: typing.Optional[typing.Dict[str, str]]

GetSdkTypeRequest

id

• Type:
• Required: Yes

GetSdkTypesRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetSdkTypesRequestPaginate

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetStageRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

GetStagesRequest

restApiId

• Type:
• Required: Yes

deploymentId

• Type: typing.Optional[str]

GetTagsRequest

resourceArn

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetUsagePlanKeyRequest

usagePlanId

• Type:
• Required: Yes

keyId

• Type:
• Required: Yes

GetUsagePlanKeysRequest

usagePlanId

• Type:
• Required: Yes

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

nameQuery

• Type: typing.Optional[str]

GetUsagePlanKeysRequestPaginate

usagePlanId

• Type:
• Required: Yes

nameQuery

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetUsagePlanRequest

usagePlanId

• Type:
• Required: Yes

GetUsagePlansRequest

position

• Type: typing.Optional[str]

keyId

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetUsagePlansRequestPaginate

keyId

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetUsageRequest

usagePlanId

• Type:
• Required: Yes

startDate

• Type:
• Required: Yes

endDate

• Type:
• Required: Yes

keyId

• Type: typing.Optional[str]

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetUsageRequestPaginate

usagePlanId

• Type:
• Required: Yes

startDate

• Type:
• Required: Yes

endDate

• Type:
• Required: Yes

keyId

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

GetVpcLinkRequest

vpcLinkId

• Type:
• Required: Yes

GetVpcLinksRequest

position

• Type: typing.Optional[str]

limit

• Type: typing.Optional[int]

GetVpcLinksRequestPaginate

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PaginatorConfig]

ImportApiKeysRequest

body

• Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
• Required: Yes

format

• Type: typing.Literal['csv']
• Required: Yes

failOnWarnings

• Type: typing.Optional[bool]

ImportDocumentationPartsRequest

restApiId

• Type:
• Required: Yes

body

• Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
• Required: Yes

mode

• Type: typing.Optional[typing.Literal['merge', 'overwrite']]

failOnWarnings

• Type: typing.Optional[bool]

ImportRestApiRequest

body

• Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
• Required: Yes

failOnWarnings

• Type: typing.Optional[bool]

parameters

• Type: typing.Optional[typing.Dict[str, str]]

Integration

type

• Type: typing.Optional[typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']]

httpMethod

• Type: typing.Optional[str]

uri

• Type: typing.Optional[str]

connectionType

• Type: typing.Optional[typing.Literal['INTERNET', 'VPC_LINK']]

connectionId

• Type: typing.Optional[str]

credentials

• Type: typing.Optional[str]

requestParameters

• Type: typing.Optional[typing.Dict[str, str]]

requestTemplates

• Type: typing.Optional[typing.Dict[str, str]]

passthroughBehavior

• Type: typing.Optional[str]

contentHandling

• Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

timeoutInMillis

• Type: typing.Optional[int]

cacheNamespace

• Type: typing.Optional[str]

cacheKeyParameters

• Type: typing.Optional[typing.List[str]]

integrationResponses

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.IntegrationResponse]]

tlsConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.TlsConfig]

IntegrationResponse

statusCode

• Type: typing.Optional[str]

selectionPattern

• Type: typing.Optional[str]

responseParameters

• Type: typing.Optional[typing.Dict[str, str]]

responseTemplates

• Type: typing.Optional[typing.Dict[str, str]]

contentHandling

• Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

IntegrationResponseExtra

type

• Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
• Required: Yes

httpMethod

• Type:
• Required: Yes

uri

• Type:
• Required: Yes

connectionType

• Type: typing.Literal['INTERNET', 'VPC_LINK']
• Required: Yes

connectionId

• Type:
• Required: Yes

credentials

• Type:
• Required: Yes

requestParameters

• Type: typing.Dict[str, str]
• Required: Yes

requestTemplates

• Type: typing.Dict[str, str]
• Required: Yes

passthroughBehavior

• Type:
• Required: Yes

contentHandling

• Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
• Required: Yes

timeoutInMillis

• Type:
• Required: Yes

cacheNamespace

• Type:
• Required: Yes

cacheKeyParameters

• Type: typing.List[str]
• Required: Yes

integrationResponses

• Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.IntegrationResponse]
• Required: Yes

tlsConfig

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

IntegrationResponseResponse

statusCode

• Type:
• Required: Yes

selectionPattern

• Type:
• Required: Yes

responseParameters

• Type: typing.Dict[str, str]
• Required: Yes

responseTemplates

• Type: typing.Dict[str, str]
• Required: Yes

contentHandling

• Type: typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Method

httpMethod

• Type: typing.Optional[str]

authorizationType

• Type: typing.Optional[str]

authorizerId

• Type: typing.Optional[str]

apiKeyRequired

• Type: typing.Optional[bool]

requestValidatorId

• Type: typing.Optional[str]

operationName

• Type: typing.Optional[str]

requestParameters

• Type: typing.Optional[typing.Dict[str, bool]]

requestModels

• Type: typing.Optional[typing.Dict[str, str]]

methodResponses

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodResponse]]

methodIntegration

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Integration]

authorizationScopes

• Type: typing.Optional[typing.List[str]]

MethodResponse

statusCode

• Type: typing.Optional[str]

responseParameters

• Type: typing.Optional[typing.Dict[str, bool]]

responseModels

• Type: typing.Optional[typing.Dict[str, str]]

MethodResponseExtra

httpMethod

• Type:
• Required: Yes

authorizationType

• Type:
• Required: Yes

authorizerId

• Type:
• Required: Yes

apiKeyRequired

• Type:
• Required: Yes

requestValidatorId

• Type:
• Required: Yes

operationName

• Type:
• Required: Yes

requestParameters

• Type: typing.Dict[str, bool]
• Required: Yes

requestModels

• Type: typing.Dict[str, str]
• Required: Yes

methodResponses

• Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodResponse]
• Required: Yes

methodIntegration

• Type:
• Required: Yes

authorizationScopes

• Type: typing.List[str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

MethodResponseResponse

statusCode

• Type:
• Required: Yes

responseParameters

• Type: typing.Dict[str, bool]
• Required: Yes

responseModels

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

MethodSetting

metricsEnabled

• Type: typing.Optional[bool]

loggingLevel

• Type: typing.Optional[str]

dataTraceEnabled

• Type: typing.Optional[bool]

throttlingBurstLimit

• Type: typing.Optional[int]

throttlingRateLimit

• Type: typing.Optional[float]

cachingEnabled

• Type: typing.Optional[bool]

cacheTtlInSeconds

• Type: typing.Optional[int]

cacheDataEncrypted

• Type: typing.Optional[bool]

requireAuthorizationForCacheControl

• Type: typing.Optional[bool]

unauthorizedCacheControlHeaderStrategy

• Type: typing.Optional[typing.Literal['FAIL_WITH_403', 'SUCCEED_WITHOUT_RESPONSE_HEADER', 'SUCCEED_WITH_RESPONSE_HEADER']]

MethodSnapshot

authorizationType

• Type: typing.Optional[str]

apiKeyRequired

• Type: typing.Optional[bool]

Model

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

schema

• Type: typing.Optional[str]

contentType

• Type: typing.Optional[str]

ModelResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

description

• Type:
• Required: Yes

schema

• Type:
• Default: >

contentType

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Models

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Model]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

MutualTlsAuthentication

truststoreUri

• Type: typing.Optional[str]

truststoreVersion

• Type: typing.Optional[str]

truststoreWarnings

• Type: typing.Optional[typing.List[str]]

MutualTlsAuthenticationInput

truststoreUri

• Type: typing.Optional[str]

truststoreVersion

• Type: typing.Optional[str]

PaginatorConfig

MaxItems

• Type: typing.Optional[int]

PageSize

• Type: typing.Optional[int]

StartingToken

• Type: typing.Optional[str]

PatchOperation

op

• Type: typing.Optional[typing.Literal['add', 'copy', 'move', 'remove', 'replace', 'test']]

path

• Type: typing.Optional[str]

value

• Type: typing.Optional[str]

from_

• Type: typing.Optional[str]

PutGatewayResponseRequest

restApiId

• Type:
• Required: Yes

responseType

• Type: typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']
• Required: Yes

statusCode

• Type: typing.Optional[str]

responseParameters

• Type: typing.Optional[typing.Dict[str, str]]

responseTemplates

• Type: typing.Optional[typing.Dict[str, str]]

PutIntegrationRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

type

• Type: typing.Literal['AWS', 'AWS_PROXY', 'HTTP', 'HTTP_PROXY', 'MOCK']
• Required: Yes

integrationHttpMethod

• Type: typing.Optional[str]

uri

• Type: typing.Optional[str]

connectionType

• Type: typing.Optional[typing.Literal['INTERNET', 'VPC_LINK']]

connectionId

• Type: typing.Optional[str]

credentials

• Type: typing.Optional[str]

requestParameters

• Type: typing.Optional[typing.Dict[str, str]]

requestTemplates

• Type: typing.Optional[typing.Dict[str, str]]

passthroughBehavior

• Type: typing.Optional[str]

cacheNamespace

• Type: typing.Optional[str]

cacheKeyParameters

• Type: typing.Optional[typing.List[str]]

contentHandling

• Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

timeoutInMillis

• Type: typing.Optional[int]

tlsConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.TlsConfig]

PutIntegrationResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

selectionPattern

• Type: typing.Optional[str]

responseParameters

• Type: typing.Optional[typing.Dict[str, str]]

responseTemplates

• Type: typing.Optional[typing.Dict[str, str]]

contentHandling

• Type: typing.Optional[typing.Literal['CONVERT_TO_BINARY', 'CONVERT_TO_TEXT']]

PutMethodRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

authorizationType

• Type:
• Required: Yes

authorizerId

• Type: typing.Optional[str]

apiKeyRequired

• Type: typing.Optional[bool]

operationName

• Type: typing.Optional[str]

requestParameters

• Type: typing.Optional[typing.Dict[str, bool]]

requestModels

• Type: typing.Optional[typing.Dict[str, str]]

requestValidatorId

• Type: typing.Optional[str]

authorizationScopes

• Type: typing.Optional[typing.List[str]]

PutMethodResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

responseParameters

• Type: typing.Optional[typing.Dict[str, bool]]

responseModels

• Type: typing.Optional[typing.Dict[str, str]]

PutRestApiRequest

restApiId

• Type:
• Required: Yes

body

• Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
• Required: Yes

mode

• Type: typing.Optional[typing.Literal['merge', 'overwrite']]

failOnWarnings

• Type: typing.Optional[bool]

parameters

• Type: typing.Optional[typing.Dict[str, str]]

QuotaSettings

limit

• Type: typing.Optional[int]

offset

• Type: typing.Optional[int]

period

• Type: typing.Optional[typing.Literal['DAY', 'MONTH', 'WEEK']]

RejectDomainNameAccessAssociationRequest

domainNameAccessAssociationArn

• Type:
• Required: Yes

domainNameArn

• Type:
• Required: Yes

RequestValidator

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

validateRequestBody

• Type: typing.Optional[bool]

validateRequestParameters

• Type: typing.Optional[bool]

RequestValidatorResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

validateRequestBody

• Type:
• Required: Yes

validateRequestParameters

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

RequestValidators

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.RequestValidator]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Resource

id

• Type: typing.Optional[str]

parentId

• Type: typing.Optional[str]

pathPart

• Type: typing.Optional[str]

path

• Type: typing.Optional[str]

resourceMethods

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Method]]

ResourceResponse

id

• Type:
• Required: Yes

parentId

• Type:
• Required: Yes

pathPart

• Type:
• Required: Yes

path

• Type:
• Required: Yes

resourceMethods

• Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Method]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Resources

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Resource]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ResponseMetadata

RequestId

• Type:
• Required: Yes

HTTPStatusCode

• Type:
• Required: Yes

HTTPHeaders

• Type: typing.Dict[str, str]
• Required: Yes

RetryAttempts

• Type:
• Required: Yes

HostId

• Type: typing.Optional[str]

RestApi

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

createdDate

• Type: typing.Optional[datetime.datetime]

version

• Type: typing.Optional[str]

warnings

• Type: typing.Optional[typing.List[str]]

binaryMediaTypes

• Type: typing.Optional[typing.List[str]]

minimumCompressionSize

• Type: typing.Optional[int]

apiKeySource

• Type: typing.Optional[typing.Literal['AUTHORIZER', 'HEADER']]

endpointConfiguration

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.EndpointConfigurationOutput]

policy

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

disableExecuteApiEndpoint

• Type: typing.Optional[bool]

rootResourceId

• Type: typing.Optional[str]

RestApiResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

description

• Type:
• Required: Yes

createdDate

• Type:
• Required: Yes

version

• Type:
• Required: Yes

warnings

• Type: typing.List[str]
• Required: Yes

binaryMediaTypes

• Type: typing.List[str]
• Required: Yes

minimumCompressionSize

• Type:
• Required: Yes

apiKeySource

• Type: typing.Literal['AUTHORIZER', 'HEADER']
• Required: Yes

endpointConfiguration

• Type:
• Required: Yes

policy

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

disableExecuteApiEndpoint

• Type:
• Required: Yes

rootResourceId

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

RestApis

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.RestApi]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

SdkConfigurationProperty

name

• Type: typing.Optional[str]

friendlyName

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

required

• Type: typing.Optional[bool]

defaultValue

• Type: typing.Optional[str]

SdkResponse

contentType

• Type:
• Required: Yes

contentDisposition

• Type:
• Required: Yes

body

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

SdkType

id

• Type: typing.Optional[str]

friendlyName

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

configurationProperties

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.SdkConfigurationProperty]]

SdkTypeResponse

id

• Type:
• Required: Yes

friendlyName

• Type:
• Required: Yes

description

• Type:
• Required: Yes

configurationProperties

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.SdkConfigurationProperty]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

SdkTypes

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.SdkType]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Stage

deploymentId

• Type: typing.Optional[str]

clientCertificateId

• Type: typing.Optional[str]

stageName

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

cacheClusterEnabled

• Type: typing.Optional[bool]

cacheClusterSize

• Type: typing.Optional[typing.Literal['0.5', '1.6', '118', '13.5', '237', '28.4', '58.2', '6.1']]

cacheClusterStatus

• Type: typing.Optional[typing.Literal['AVAILABLE', 'CREATE_IN_PROGRESS', 'DELETE_IN_PROGRESS', 'FLUSH_IN_PROGRESS', 'NOT_AVAILABLE']]

methodSettings

• Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodSetting]]

variables

• Type: typing.Optional[typing.Dict[str, str]]

documentationVersion

• Type: typing.Optional[str]

accessLogSettings

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.AccessLogSettings]

canarySettings

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.CanarySettingsOutput]

tracingEnabled

• Type: typing.Optional[bool]

webAclArn

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

createdDate

• Type: typing.Optional[datetime.datetime]

lastUpdatedDate

• Type: typing.Optional[datetime.datetime]

StageKey

restApiId

• Type: typing.Optional[str]

stageName

• Type: typing.Optional[str]

StageResponse

deploymentId

• Type:
• Required: Yes

clientCertificateId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

description

• Type:
• Required: Yes

cacheClusterEnabled

• Type:
• Required: Yes

cacheClusterSize

• Type: typing.Literal['0.5', '1.6', '118', '13.5', '237', '28.4', '58.2', '6.1']
• Required: Yes

cacheClusterStatus

• Type: typing.Literal['AVAILABLE', 'CREATE_IN_PROGRESS', 'DELETE_IN_PROGRESS', 'FLUSH_IN_PROGRESS', 'NOT_AVAILABLE']
• Required: Yes

methodSettings

• Type: typing.Dict[str, aws_resource_validator.pydantic_models.apigateway.apigateway_classes.MethodSetting]
• Required: Yes

variables

• Type: typing.Dict[str, str]
• Required: Yes

documentationVersion

• Type:
• Required: Yes

accessLogSettings

• Type:
• Required: Yes

canarySettings

• Type:
• Required: Yes

tracingEnabled

• Type:
• Required: Yes

webAclArn

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

createdDate

• Type:
• Required: Yes

lastUpdatedDate

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Stages

item

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.Stage]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

TagResourceRequest

resourceArn

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

Tags

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

Template

value

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

TestInvokeAuthorizerRequest

restApiId

• Type:
• Required: Yes

authorizerId

• Type:
• Required: Yes

headers

• Type: typing.Optional[typing.Dict[str, str]]

multiValueHeaders

• Type: typing.Optional[typing.Dict[str, typing.List[str]]]

pathWithQueryString

• Type: typing.Optional[str]

body

• Type: typing.Optional[str]

stageVariables

• Type: typing.Optional[typing.Dict[str, str]]

additionalContext

• Type: typing.Optional[typing.Dict[str, str]]

TestInvokeAuthorizerResponse

clientStatus

• Type:
• Required: Yes

log

• Type:
• Required: Yes

latency

• Type:
• Required: Yes

principalId

• Type:
• Required: Yes

policy

• Type:
• Required: Yes

authorization

• Type: typing.Dict[str, typing.List[str]]
• Required: Yes

claims

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

TestInvokeMethodRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

pathWithQueryString

• Type: typing.Optional[str]

body

• Type: typing.Optional[str]

headers

• Type: typing.Optional[typing.Dict[str, str]]

multiValueHeaders

• Type: typing.Optional[typing.Dict[str, typing.List[str]]]

clientCertificateId

• Type: typing.Optional[str]

stageVariables

• Type: typing.Optional[typing.Dict[str, str]]

TestInvokeMethodResponse

status

• Type:
• Required: Yes

body

• Type:
• Required: Yes

headers

• Type: typing.Dict[str, str]
• Required: Yes

multiValueHeaders

• Type: typing.Dict[str, typing.List[str]]
• Required: Yes

log

• Type:
• Required: Yes

latency

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ThrottleSettings

burstLimit

• Type: typing.Optional[int]

rateLimit

• Type: typing.Optional[float]

TlsConfig

insecureSkipVerification

• Type: typing.Optional[bool]

UntagResourceRequest

resourceArn

• Type:
• Required: Yes

tagKeys

• Type: typing.List[str]
• Required: Yes

UpdateAccountRequest

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateApiKeyRequest

apiKey

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateAuthorizerRequest

restApiId

• Type:
• Required: Yes

authorizerId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateBasePathMappingRequest

domainName

• Type:
• Required: Yes

basePath

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateClientCertificateRequest

clientCertificateId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateDeploymentRequest

restApiId

• Type:
• Required: Yes

deploymentId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateDocumentationPartRequest

restApiId

• Type:
• Required: Yes

documentationPartId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateDocumentationVersionRequest

restApiId

• Type:
• Required: Yes

documentationVersion

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateDomainNameRequest

domainName

• Type:
• Required: Yes

domainNameId

• Type: typing.Optional[str]

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateGatewayResponseRequest

restApiId

• Type:
• Required: Yes

responseType

• Type: typing.Literal['ACCESS_DENIED', 'API_CONFIGURATION_ERROR', 'AUTHORIZER_CONFIGURATION_ERROR', 'AUTHORIZER_FAILURE', 'BAD_REQUEST_BODY', 'BAD_REQUEST_PARAMETERS', 'DEFAULT_4XX', 'DEFAULT_5XX', 'EXPIRED_TOKEN', 'INTEGRATION_FAILURE', 'INTEGRATION_TIMEOUT', 'INVALID_API_KEY', 'INVALID_SIGNATURE', 'MISSING_AUTHENTICATION_TOKEN', 'QUOTA_EXCEEDED', 'REQUEST_TOO_LARGE', 'RESOURCE_NOT_FOUND', 'THROTTLED', 'UNAUTHORIZED', 'UNSUPPORTED_MEDIA_TYPE', 'WAF_FILTERED']
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateIntegrationRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateIntegrationResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateMethodRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateMethodResponseRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

httpMethod

• Type:
• Required: Yes

statusCode

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateModelRequest

restApiId

• Type:
• Required: Yes

modelName

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateRequestValidatorRequest

restApiId

• Type:
• Required: Yes

requestValidatorId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateResourceRequest

restApiId

• Type:
• Required: Yes

resourceId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateRestApiRequest

restApiId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateStageRequest

restApiId

• Type:
• Required: Yes

stageName

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateUsagePlanRequest

usagePlanId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateUsageRequest

usagePlanId

• Type:
• Required: Yes

keyId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

UpdateVpcLinkRequest

vpcLinkId

• Type:
• Required: Yes

patchOperations

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.PatchOperation]]

Usage

usagePlanId

• Type:
• Required: Yes

startDate

• Type:
• Required: Yes

endDate

• Type:
• Required: Yes

position

• Type:
• Required: Yes

items

• Type: typing.Dict[str, typing.List[typing.List[int]]]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UsagePlan

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

apiStages

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ApiStageOutput]]

throttle

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ThrottleSettings]

quota

• Type: typing.Optional[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.QuotaSettings]

productCode

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

UsagePlanKey

id

• Type: typing.Optional[str]

type

• Type: typing.Optional[str]

value

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

UsagePlanKeyResponse

id

• Type:
• Required: Yes

type

• Type:
• Required: Yes

value

• Type:
• Required: Yes

name

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UsagePlanKeys

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.UsagePlanKey]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UsagePlanResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

description

• Type:
• Required: Yes

apiStages

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.ApiStageOutput]
• Required: Yes

throttle

• Type:
• Required: Yes

quota

• Type:
• Required: Yes

productCode

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UsagePlans

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.UsagePlan]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

VpcLink

id

• Type: typing.Optional[str]

name

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

targetArns

• Type: typing.Optional[typing.List[str]]

status

• Type: typing.Optional[typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'PENDING']]

statusMessage

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Dict[str, str]]

VpcLinkResponse

id

• Type:
• Required: Yes

name

• Type:
• Required: Yes

description

• Type:
• Required: Yes

targetArns

• Type: typing.List[str]
• Required: Yes

status

• Type: typing.Literal['AVAILABLE', 'DELETING', 'FAILED', 'PENDING']
• Required: Yes

statusMessage

• Type:
• Required: Yes

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

VpcLinks

position

• Type:
• Required: Yes

items

• Type: typing.List[aws_resource_validator.pydantic_models.apigateway.apigateway_classes.VpcLink]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes