Uses of Package
software.amazon.awssdk.services.apigateway.model

Packages that use software.amazon.awssdk.services.apigateway.model

Package	Description
software.amazon.awssdk.services.apigateway	Amazon API Gateway
software.amazon.awssdk.services.apigateway.internal
software.amazon.awssdk.services.apigateway.model
software.amazon.awssdk.services.apigateway.paginators
software.amazon.awssdk.services.apigateway.transform

Classes in software.amazon.awssdk.services.apigateway.model used by software.amazon.awssdk.services.apigateway

Class and Description
ApiGatewayException
BadRequestException The submitted request is not valid, for example, the input is incomplete or incorrect.
ConflictException The request configuration has conflicts.
CreateApiKeyRequest Request to create an ApiKey resource.
CreateApiKeyRequest.Builder
CreateApiKeyResponse A resource that can be distributed to callers for executing Method resources that require an API key.
CreateAuthorizerRequest Request to add a new Authorizer to an existing RestApi resource.
CreateAuthorizerRequest.Builder
CreateAuthorizerResponse Represents an authorization layer for methods.
CreateBasePathMappingRequest Requests API Gateway to create a new BasePathMapping resource.
CreateBasePathMappingRequest.Builder
CreateBasePathMappingResponse Represents the base path that callers of the API must provide as part of the URL after the domain name.
CreateDeploymentRequest Requests API Gateway to create a Deployment resource.
CreateDeploymentRequest.Builder
CreateDeploymentResponse An immutable representation of a RestApi resource that can be called by users using Stages.
CreateDocumentationPartRequest Creates a new documentation part of a given API.
CreateDocumentationPartRequest.Builder
CreateDocumentationPartResponse A documentation part for a targeted API entity.
CreateDocumentationVersionRequest Creates a new documentation version of a given API.
CreateDocumentationVersionRequest.Builder
CreateDocumentationVersionResponse A snapshot of the documentation of an API.
CreateDomainNameRequest A request to create a new domain name.
CreateDomainNameRequest.Builder
CreateDomainNameResponse Represents a custom domain name as a user-friendly host name of an API (RestApi).
CreateModelRequest Request to add a new Model to an existing RestApi resource.
CreateModelRequest.Builder
CreateModelResponse Represents the data structure of a method's request or response payload.
CreateRequestValidatorRequest Creates a RequestValidator of a given RestApi.
CreateRequestValidatorRequest.Builder
CreateRequestValidatorResponse A set of validation rules for incoming Method requests.
CreateResourceRequest Requests API Gateway to create a Resource resource.
CreateResourceRequest.Builder
CreateResourceResponse Represents an API resource.
CreateRestApiRequest The POST Request to add a new RestApi resource to your collection.
CreateRestApiRequest.Builder
CreateRestApiResponse Represents a REST API.
CreateStageRequest Requests API Gateway to create a Stage resource.
CreateStageRequest.Builder
CreateStageResponse Represents a unique identifier for a version of a deployed RestApi that is callable by users.
CreateUsagePlanKeyRequest The POST request to create a usage plan key for adding an existing API key to a usage plan.
CreateUsagePlanKeyRequest.Builder
CreateUsagePlanKeyResponse Represents a usage plan key to identify a plan customer.
CreateUsagePlanRequest The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
CreateUsagePlanRequest.Builder
CreateUsagePlanResponse Represents a usage plan used to specify who can assess associated API stages.
CreateVpcLinkRequest Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.
CreateVpcLinkRequest.Builder
CreateVpcLinkResponse An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
DeleteApiKeyRequest A request to delete the ApiKey resource.
DeleteApiKeyRequest.Builder
DeleteApiKeyResponse
DeleteAuthorizerRequest Request to delete an existing Authorizer resource.
DeleteAuthorizerRequest.Builder
DeleteAuthorizerResponse
DeleteBasePathMappingRequest A request to delete the BasePathMapping resource.
DeleteBasePathMappingRequest.Builder
DeleteBasePathMappingResponse
DeleteClientCertificateRequest A request to delete the ClientCertificate resource.
DeleteClientCertificateRequest.Builder
DeleteClientCertificateResponse
DeleteDeploymentRequest Requests API Gateway to delete a Deployment resource.
DeleteDeploymentRequest.Builder
DeleteDeploymentResponse
DeleteDocumentationPartRequest Deletes an existing documentation part of an API.
DeleteDocumentationPartRequest.Builder
DeleteDocumentationPartResponse
DeleteDocumentationVersionRequest Deletes an existing documentation version of an API.
DeleteDocumentationVersionRequest.Builder
DeleteDocumentationVersionResponse
DeleteDomainNameRequest A request to delete the DomainName resource.
DeleteDomainNameRequest.Builder
DeleteDomainNameResponse
DeleteGatewayResponseRequest Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
DeleteGatewayResponseRequest.Builder
DeleteGatewayResponseResponse
DeleteIntegrationRequest Represents a delete integration request.
DeleteIntegrationRequest.Builder
DeleteIntegrationResponse
DeleteIntegrationResponseRequest Represents a delete integration response request.
DeleteIntegrationResponseRequest.Builder
DeleteIntegrationResponseResponse
DeleteMethodRequest Request to delete an existing Method resource.
DeleteMethodRequest.Builder
DeleteMethodResponse
DeleteMethodResponseRequest A request to delete an existing MethodResponse resource.
DeleteMethodResponseRequest.Builder
DeleteMethodResponseResponse
DeleteModelRequest Request to delete an existing model in an existing RestApi resource.
DeleteModelRequest.Builder
DeleteModelResponse
DeleteRequestValidatorRequest Deletes a specified RequestValidator of a given RestApi.
DeleteRequestValidatorRequest.Builder
DeleteRequestValidatorResponse
DeleteResourceRequest Request to delete a Resource.
DeleteResourceRequest.Builder
DeleteResourceResponse
DeleteRestApiRequest Request to delete the specified API from your collection.
DeleteRestApiRequest.Builder
DeleteRestApiResponse
DeleteStageRequest Requests API Gateway to delete a Stage resource.
DeleteStageRequest.Builder
DeleteStageResponse
DeleteUsagePlanKeyRequest The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
DeleteUsagePlanKeyRequest.Builder
DeleteUsagePlanKeyResponse
DeleteUsagePlanRequest The DELETE request to delete a usage plan of a given plan Id.
DeleteUsagePlanRequest.Builder
DeleteUsagePlanResponse
DeleteVpcLinkRequest Deletes an existing VpcLink of a specified identifier.
DeleteVpcLinkRequest.Builder
DeleteVpcLinkResponse
FlushStageAuthorizersCacheRequest Request to flush authorizer cache entries on a specified stage.
FlushStageAuthorizersCacheRequest.Builder
FlushStageAuthorizersCacheResponse
FlushStageCacheRequest Requests API Gateway to flush a stage's cache.
FlushStageCacheRequest.Builder
FlushStageCacheResponse
GenerateClientCertificateRequest A request to generate a ClientCertificate resource.
GenerateClientCertificateRequest.Builder
GenerateClientCertificateResponse Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
GetAccountRequest Requests API Gateway to get information about the current Account resource.
GetAccountRequest.Builder
GetAccountResponse Represents an AWS account that is associated with API Gateway.
GetApiKeyRequest A request to get information about the current ApiKey resource.
GetApiKeyRequest.Builder
GetApiKeyResponse A resource that can be distributed to callers for executing Method resources that require an API key.
GetApiKeysRequest A request to get information about the current ApiKeys resource.
GetApiKeysRequest.Builder
GetApiKeysResponse Represents a collection of API keys as represented by an ApiKeys resource.
GetAuthorizerRequest Request to describe an existing Authorizer resource.
GetAuthorizerRequest.Builder
GetAuthorizerResponse Represents an authorization layer for methods.
GetAuthorizersRequest Request to describe an existing Authorizers resource.
GetAuthorizersRequest.Builder
GetAuthorizersResponse Represents a collection of Authorizer resources.
GetBasePathMappingRequest Request to describe a BasePathMapping resource.
GetBasePathMappingRequest.Builder
GetBasePathMappingResponse Represents the base path that callers of the API must provide as part of the URL after the domain name.
GetBasePathMappingsRequest A request to get information about a collection of BasePathMapping resources.
GetBasePathMappingsRequest.Builder
GetBasePathMappingsResponse Represents a collection of BasePathMapping resources.
GetClientCertificateRequest A request to get information about the current ClientCertificate resource.
GetClientCertificateRequest.Builder
GetClientCertificateResponse Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
GetClientCertificatesRequest A request to get information about a collection of ClientCertificate resources.
GetClientCertificatesRequest.Builder
GetClientCertificatesResponse Represents a collection of ClientCertificate resources.
GetDeploymentRequest Requests API Gateway to get information about a Deployment resource.
GetDeploymentRequest.Builder
GetDeploymentResponse An immutable representation of a RestApi resource that can be called by users using Stages.
GetDeploymentsRequest Requests API Gateway to get information about a Deployments collection.
GetDeploymentsRequest.Builder
GetDeploymentsResponse Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection.
GetDocumentationPartRequest Gets a specified documentation part of a given API.
GetDocumentationPartRequest.Builder
GetDocumentationPartResponse A documentation part for a targeted API entity.
GetDocumentationPartsRequest Gets the documentation parts of an API.
GetDocumentationPartsRequest.Builder
GetDocumentationPartsResponse The collection of documentation parts of an API.
GetDocumentationVersionRequest Gets a documentation snapshot of an API.
GetDocumentationVersionRequest.Builder
GetDocumentationVersionResponse A snapshot of the documentation of an API.
GetDocumentationVersionsRequest Gets the documentation versions of an API.
GetDocumentationVersionsRequest.Builder
GetDocumentationVersionsResponse The collection of documentation snapshots of an API.
GetDomainNameRequest Request to get the name of a DomainName resource.
GetDomainNameRequest.Builder
GetDomainNameResponse Represents a custom domain name as a user-friendly host name of an API (RestApi).
GetDomainNamesRequest Request to describe a collection of DomainName resources.
GetDomainNamesRequest.Builder
GetDomainNamesResponse Represents a collection of DomainName resources.
GetExportRequest Request a new export of a RestApi for a particular Stage.
GetExportRequest.Builder
GetExportResponse The binary blob response to GetExport, which contains the generated SDK.
GetGatewayResponseRequest Gets a GatewayResponse of a specified response type on the given RestApi.
GetGatewayResponseRequest.Builder
GetGatewayResponseResponse A gateway response of a given response type and status code, with optional response parameters and mapping templates.
GetGatewayResponsesRequest Gets the GatewayResponses collection on the given RestApi.
GetGatewayResponsesRequest.Builder
GetGatewayResponsesResponse The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs.
GetIntegrationRequest Represents a request to get the integration configuration.
GetIntegrationRequest.Builder
GetIntegrationResponse Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
GetIntegrationResponseRequest Represents a get integration response request.
GetIntegrationResponseRequest.Builder
GetIntegrationResponseResponse Represents an integration response.
GetMethodRequest Request to describe an existing Method resource.
GetMethodRequest.Builder
GetMethodResponse Represents a client-facing interface by which the client calls the API to access back-end resources.
GetMethodResponseRequest Request to describe a MethodResponse resource.
GetMethodResponseRequest.Builder
GetMethodResponseResponse Represents a method response of a given HTTP status code returned to the client.
GetModelRequest Request to list information about a model in an existing RestApi resource.
GetModelRequest.Builder
GetModelResponse Represents the data structure of a method's request or response payload.
GetModelsRequest Request to list existing Models defined for a RestApi resource.
GetModelsRequest.Builder
GetModelsResponse Represents a collection of Model resources.
GetModelTemplateRequest Request to generate a sample mapping template used to transform the payload.
GetModelTemplateRequest.Builder
GetModelTemplateResponse Represents a mapping template used to transform a payload.
GetRequestValidatorRequest Gets a RequestValidator of a given RestApi.
GetRequestValidatorRequest.Builder
GetRequestValidatorResponse A set of validation rules for incoming Method requests.
GetRequestValidatorsRequest Gets the RequestValidators collection of a given RestApi.
GetRequestValidatorsRequest.Builder
GetRequestValidatorsResponse A collection of RequestValidator resources of a given RestApi.
GetResourceRequest Request to list information about a resource.
GetResourceRequest.Builder
GetResourceResponse Represents an API resource.
GetResourcesRequest Request to list information about a collection of resources.
GetResourcesRequest.Builder
GetResourcesResponse Represents a collection of Resource resources.
GetRestApiRequest The GET request to list an existing RestApi defined for your collection.
GetRestApiRequest.Builder
GetRestApiResponse Represents a REST API.
GetRestApisRequest The GET request to list existing RestApis defined for your collection.
GetRestApisRequest.Builder
GetRestApisResponse Contains references to your APIs and links that guide you in how to interact with your collection.
GetSdkRequest Request a new generated client SDK for a RestApi and Stage.
GetSdkRequest.Builder
GetSdkResponse The binary blob response to GetSdk, which contains the generated SDK.
GetSdkTypeRequest Get an SdkType instance.
GetSdkTypeRequest.Builder
GetSdkTypeResponse A type of SDK that API Gateway can generate.
GetSdkTypesRequest Get the SdkTypes collection.
GetSdkTypesRequest.Builder
GetSdkTypesResponse The collection of SdkType instances.
GetStageRequest Requests API Gateway to get information about a Stage resource.
GetStageRequest.Builder
GetStageResponse Represents a unique identifier for a version of a deployed RestApi that is callable by users.
GetStagesRequest Requests API Gateway to get information about one or more Stage resources.
GetStagesRequest.Builder
GetStagesResponse A list of Stage resources that are associated with the ApiKey resource.
GetTagsRequest Gets the Tags collection for a given resource.
GetTagsRequest.Builder
GetTagsResponse The collection of tags.
GetUsagePlanKeyRequest The GET request to get a usage plan key of a given key identifier.
GetUsagePlanKeyRequest.Builder
GetUsagePlanKeyResponse Represents a usage plan key to identify a plan customer.
GetUsagePlanKeysRequest The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
GetUsagePlanKeysRequest.Builder
GetUsagePlanKeysResponse Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
GetUsagePlanRequest The GET request to get a usage plan of a given plan identifier.
GetUsagePlanRequest.Builder
GetUsagePlanResponse Represents a usage plan used to specify who can assess associated API stages.
GetUsagePlansRequest The GET request to get all the usage plans of the caller's account.
GetUsagePlansRequest.Builder
GetUsagePlansResponse Represents a collection of usage plans for an AWS account.
GetUsageRequest The GET request to get the usage data of a usage plan in a specified time interval.
GetUsageRequest.Builder
GetUsageResponse Represents the usage data of a usage plan.
GetVpcLinkRequest Gets a specified VPC link under the caller's account in a region.
GetVpcLinkRequest.Builder
GetVpcLinkResponse An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
GetVpcLinksRequest Gets the VpcLinks collection under the caller's account in a selected region.
GetVpcLinksRequest.Builder
GetVpcLinksResponse The collection of VPC links under the caller's account in a region.
ImportApiKeysRequest The POST request to import API keys from an external source, such as a CSV-formatted file.
ImportApiKeysRequest.Builder
ImportApiKeysResponse The identifier of an ApiKey used in a UsagePlan.
ImportDocumentationPartsRequest Import documentation parts from an external (e.g., OpenAPI) definition file.
ImportDocumentationPartsRequest.Builder
ImportDocumentationPartsResponse A collection of the imported DocumentationPart identifiers.
ImportRestApiRequest A POST request to import an API to API Gateway using an input of an API definition file.
ImportRestApiRequest.Builder
ImportRestApiResponse Represents a REST API.
LimitExceededException The request exceeded the rate limit.
NotFoundException The requested resource is not found.
PutGatewayResponseRequest Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
PutGatewayResponseRequest.Builder
PutGatewayResponseResponse A gateway response of a given response type and status code, with optional response parameters and mapping templates.
PutIntegrationRequest Sets up a method's integration.
PutIntegrationRequest.Builder
PutIntegrationResponse Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
PutIntegrationResponseRequest Represents a put integration response request.
PutIntegrationResponseRequest.Builder
PutIntegrationResponseResponse Represents an integration response.
PutMethodRequest Request to add a method to an existing Resource resource.
PutMethodRequest.Builder
PutMethodResponse Represents a client-facing interface by which the client calls the API to access back-end resources.
PutMethodResponseRequest Request to add a MethodResponse to an existing Method resource.
PutMethodResponseRequest.Builder
PutMethodResponseResponse Represents a method response of a given HTTP status code returned to the client.
PutRestApiRequest A PUT request to update an existing API, with external API definitions specified as the request body.
PutRestApiRequest.Builder
PutRestApiResponse Represents a REST API.
ServiceUnavailableException The requested service is not available.
TagResourceRequest Adds or updates a tag on a given resource.
TagResourceRequest.Builder
TagResourceResponse
TestInvokeAuthorizerRequest Make a request to simulate the invocation of an Authorizer.
TestInvokeAuthorizerRequest.Builder
TestInvokeAuthorizerResponse Represents the response of the test invoke request for a custom Authorizer
TestInvokeMethodRequest Make a request to simulate the invocation of a Method.
TestInvokeMethodRequest.Builder
TestInvokeMethodResponse Represents the response of the test invoke request in the HTTP method.
TooManyRequestsException The request has reached its throttling limit.
UnauthorizedException The request is denied because the caller has insufficient permissions.
UntagResourceRequest Removes a tag from a given resource.
UntagResourceRequest.Builder
UntagResourceResponse
UpdateAccountRequest Requests API Gateway to change information about the current Account resource.
UpdateAccountRequest.Builder
UpdateAccountResponse Represents an AWS account that is associated with API Gateway.
UpdateApiKeyRequest A request to change information about an ApiKey resource.
UpdateApiKeyRequest.Builder
UpdateApiKeyResponse A resource that can be distributed to callers for executing Method resources that require an API key.
UpdateAuthorizerRequest Request to update an existing Authorizer resource.
UpdateAuthorizerRequest.Builder
UpdateAuthorizerResponse Represents an authorization layer for methods.
UpdateBasePathMappingRequest A request to change information about the BasePathMapping resource.
UpdateBasePathMappingRequest.Builder
UpdateBasePathMappingResponse Represents the base path that callers of the API must provide as part of the URL after the domain name.
UpdateClientCertificateRequest A request to change information about an ClientCertificate resource.
UpdateClientCertificateRequest.Builder
UpdateClientCertificateResponse Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
UpdateDeploymentRequest Requests API Gateway to change information about a Deployment resource.
UpdateDeploymentRequest.Builder
UpdateDeploymentResponse An immutable representation of a RestApi resource that can be called by users using Stages.
UpdateDocumentationPartRequest Updates an existing documentation part of a given API.
UpdateDocumentationPartRequest.Builder
UpdateDocumentationPartResponse A documentation part for a targeted API entity.
UpdateDocumentationVersionRequest Updates an existing documentation version of an API.
UpdateDocumentationVersionRequest.Builder
UpdateDocumentationVersionResponse A snapshot of the documentation of an API.
UpdateDomainNameRequest A request to change information about the DomainName resource.
UpdateDomainNameRequest.Builder
UpdateDomainNameResponse Represents a custom domain name as a user-friendly host name of an API (RestApi).
UpdateGatewayResponseRequest Updates a GatewayResponse of a specified response type on the given RestApi.
UpdateGatewayResponseRequest.Builder
UpdateGatewayResponseResponse A gateway response of a given response type and status code, with optional response parameters and mapping templates.
UpdateIntegrationRequest Represents an update integration request.
UpdateIntegrationRequest.Builder
UpdateIntegrationResponse Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
UpdateIntegrationResponseRequest Represents an update integration response request.
UpdateIntegrationResponseRequest.Builder
UpdateIntegrationResponseResponse Represents an integration response.
UpdateMethodRequest Request to update an existing Method resource.
UpdateMethodRequest.Builder
UpdateMethodResponse Represents a client-facing interface by which the client calls the API to access back-end resources.
UpdateMethodResponseRequest A request to update an existing MethodResponse resource.
UpdateMethodResponseRequest.Builder
UpdateMethodResponseResponse Represents a method response of a given HTTP status code returned to the client.
UpdateModelRequest Request to update an existing model in an existing RestApi resource.
UpdateModelRequest.Builder
UpdateModelResponse Represents the data structure of a method's request or response payload.
UpdateRequestValidatorRequest Updates a RequestValidator of a given RestApi.
UpdateRequestValidatorRequest.Builder
UpdateRequestValidatorResponse A set of validation rules for incoming Method requests.
UpdateResourceRequest Request to change information about a Resource resource.
UpdateResourceRequest.Builder
UpdateResourceResponse Represents an API resource.
UpdateRestApiRequest Request to update an existing RestApi resource in your collection.
UpdateRestApiRequest.Builder
UpdateRestApiResponse Represents a REST API.
UpdateStageRequest Requests API Gateway to change information about a Stage resource.
UpdateStageRequest.Builder
UpdateStageResponse Represents a unique identifier for a version of a deployed RestApi that is callable by users.
UpdateUsagePlanRequest The PATCH request to update a usage plan of a given plan Id.
UpdateUsagePlanRequest.Builder
UpdateUsagePlanResponse Represents a usage plan used to specify who can assess associated API stages.
UpdateUsageRequest The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
UpdateUsageRequest.Builder
UpdateUsageResponse Represents the usage data of a usage plan.
UpdateVpcLinkRequest Updates an existing VpcLink of a specified identifier.
UpdateVpcLinkRequest.Builder
UpdateVpcLinkResponse An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

Classes in software.amazon.awssdk.services.apigateway.model used by software.amazon.awssdk.services.apigateway.internal

Class and Description
ApiGatewayRequest

Classes in software.amazon.awssdk.services.apigateway.model used by software.amazon.awssdk.services.apigateway.model

Class and Description
AccessLogSettings Access log settings, including the access log format and access log destination ARN.
AccessLogSettings.Builder
ApiGatewayException
ApiGatewayException.Builder
ApiGatewayException.BuilderImpl
ApiGatewayRequest
ApiGatewayRequest.Builder
ApiGatewayResponse
ApiGatewayResponse.Builder
ApiGatewayResponseMetadata
ApiKey A resource that can be distributed to callers for executing Method resources that require an API key.
ApiKey.Builder
ApiKeysFormat
ApiKeySourceType
ApiStage API stage name of the associated API stage in a usage plan.
ApiStage.Builder
Authorizer Represents an authorization layer for methods.
Authorizer.Builder
AuthorizerType The authorizer type.
BadRequestException.Builder
BasePathMapping Represents the base path that callers of the API must provide as part of the URL after the domain name.
BasePathMapping.Builder
CacheClusterStatus Returns the status of the CacheCluster.
CanarySettings Configuration settings of a canary deployment.
CanarySettings.Builder
ClientCertificate Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
ClientCertificate.Builder
ConflictException.Builder
ConnectionType
ContentHandlingStrategy
CreateApiKeyRequest.Builder
CreateApiKeyResponse.Builder
CreateAuthorizerRequest.Builder
CreateAuthorizerResponse.Builder
CreateBasePathMappingRequest.Builder
CreateBasePathMappingResponse.Builder
CreateDeploymentRequest.Builder
CreateDeploymentResponse.Builder
CreateDocumentationPartRequest.Builder
CreateDocumentationPartResponse.Builder
CreateDocumentationVersionRequest.Builder
CreateDocumentationVersionResponse.Builder
CreateDomainNameRequest.Builder
CreateDomainNameResponse.Builder
CreateModelRequest.Builder
CreateModelResponse.Builder
CreateRequestValidatorRequest.Builder
CreateRequestValidatorResponse.Builder
CreateResourceRequest.Builder
CreateResourceResponse.Builder
CreateRestApiRequest.Builder
CreateRestApiResponse.Builder
CreateStageRequest.Builder
CreateStageResponse.Builder
CreateUsagePlanKeyRequest.Builder
CreateUsagePlanKeyResponse.Builder
CreateUsagePlanRequest.Builder
CreateUsagePlanResponse.Builder
CreateVpcLinkRequest.Builder
CreateVpcLinkResponse.Builder
DeleteApiKeyRequest.Builder
DeleteApiKeyResponse.Builder
DeleteAuthorizerRequest.Builder
DeleteAuthorizerResponse.Builder
DeleteBasePathMappingRequest.Builder
DeleteBasePathMappingResponse.Builder
DeleteClientCertificateRequest.Builder
DeleteClientCertificateResponse.Builder
DeleteDeploymentRequest.Builder
DeleteDeploymentResponse.Builder
DeleteDocumentationPartRequest.Builder
DeleteDocumentationPartResponse.Builder
DeleteDocumentationVersionRequest.Builder
DeleteDocumentationVersionResponse.Builder
DeleteDomainNameRequest.Builder
DeleteDomainNameResponse.Builder
DeleteGatewayResponseRequest.Builder
DeleteGatewayResponseResponse.Builder
DeleteIntegrationRequest.Builder
DeleteIntegrationResponse.Builder
DeleteIntegrationResponseRequest.Builder
DeleteIntegrationResponseResponse.Builder
DeleteMethodRequest.Builder
DeleteMethodResponse.Builder
DeleteMethodResponseRequest.Builder
DeleteMethodResponseResponse.Builder
DeleteModelRequest.Builder
DeleteModelResponse.Builder
DeleteRequestValidatorRequest.Builder
DeleteRequestValidatorResponse.Builder
DeleteResourceRequest.Builder
DeleteResourceResponse.Builder
DeleteRestApiRequest.Builder
DeleteRestApiResponse.Builder
DeleteStageRequest.Builder
DeleteStageResponse.Builder
DeleteUsagePlanKeyRequest.Builder
DeleteUsagePlanKeyResponse.Builder
DeleteUsagePlanRequest.Builder
DeleteUsagePlanResponse.Builder
DeleteVpcLinkRequest.Builder
DeleteVpcLinkResponse.Builder
Deployment An immutable representation of a RestApi resource that can be called by users using Stages.
Deployment.Builder
DeploymentCanarySettings The input configuration for a canary deployment.
DeploymentCanarySettings.Builder
DocumentationPart A documentation part for a targeted API entity.
DocumentationPart.Builder
DocumentationPartLocation Specifies the target API entity to which the documentation applies.
DocumentationPartLocation.Builder
DocumentationPartType
DocumentationVersion A snapshot of the documentation of an API.
DocumentationVersion.Builder
DomainName Represents a custom domain name as a user-friendly host name of an API (RestApi).
DomainName.Builder
DomainNameStatus
EndpointConfiguration The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
EndpointConfiguration.Builder
EndpointType The endpoint type.
FlushStageAuthorizersCacheRequest.Builder
FlushStageAuthorizersCacheResponse.Builder
FlushStageCacheRequest.Builder
FlushStageCacheResponse.Builder
GatewayResponse A gateway response of a given response type and status code, with optional response parameters and mapping templates.
GatewayResponse.Builder
GatewayResponseType
GenerateClientCertificateRequest.Builder
GenerateClientCertificateResponse.Builder
GetAccountRequest.Builder
GetAccountResponse.Builder
GetApiKeyRequest.Builder
GetApiKeyResponse.Builder
GetApiKeysRequest.Builder
GetApiKeysResponse.Builder
GetAuthorizerRequest.Builder
GetAuthorizerResponse.Builder
GetAuthorizersRequest.Builder
GetAuthorizersResponse.Builder
GetBasePathMappingRequest.Builder
GetBasePathMappingResponse.Builder
GetBasePathMappingsRequest.Builder
GetBasePathMappingsResponse.Builder
GetClientCertificateRequest.Builder
GetClientCertificateResponse.Builder
GetClientCertificatesRequest.Builder
GetClientCertificatesResponse.Builder
GetDeploymentRequest.Builder
GetDeploymentResponse.Builder
GetDeploymentsRequest.Builder
GetDeploymentsResponse.Builder
GetDocumentationPartRequest.Builder
GetDocumentationPartResponse.Builder
GetDocumentationPartsRequest.Builder
GetDocumentationPartsResponse.Builder
GetDocumentationVersionRequest.Builder
GetDocumentationVersionResponse.Builder
GetDocumentationVersionsRequest.Builder
GetDocumentationVersionsResponse.Builder
GetDomainNameRequest.Builder
GetDomainNameResponse.Builder
GetDomainNamesRequest.Builder
GetDomainNamesResponse.Builder
GetExportRequest.Builder
GetExportResponse.Builder
GetGatewayResponseRequest.Builder
GetGatewayResponseResponse.Builder
GetGatewayResponsesRequest.Builder
GetGatewayResponsesResponse.Builder
GetIntegrationRequest.Builder
GetIntegrationResponse.Builder
GetIntegrationResponseRequest.Builder
GetIntegrationResponseResponse.Builder
GetMethodRequest.Builder
GetMethodResponse.Builder
GetMethodResponseRequest.Builder
GetMethodResponseResponse.Builder
GetModelRequest.Builder
GetModelResponse.Builder
GetModelsRequest.Builder
GetModelsResponse.Builder
GetModelTemplateRequest.Builder
GetModelTemplateResponse.Builder
GetRequestValidatorRequest.Builder
GetRequestValidatorResponse.Builder
GetRequestValidatorsRequest.Builder
GetRequestValidatorsResponse.Builder
GetResourceRequest.Builder
GetResourceResponse.Builder
GetResourcesRequest.Builder
GetResourcesResponse.Builder
GetRestApiRequest.Builder
GetRestApiResponse.Builder
GetRestApisRequest.Builder
GetRestApisResponse.Builder
GetSdkRequest.Builder
GetSdkResponse.Builder
GetSdkTypeRequest.Builder
GetSdkTypeResponse.Builder
GetSdkTypesRequest.Builder
GetSdkTypesResponse.Builder
GetStageRequest.Builder
GetStageResponse.Builder
GetStagesRequest.Builder
GetStagesResponse.Builder
GetTagsRequest.Builder
GetTagsResponse.Builder
GetUsagePlanKeyRequest.Builder
GetUsagePlanKeyResponse.Builder
GetUsagePlanKeysRequest.Builder
GetUsagePlanKeysResponse.Builder
GetUsagePlanRequest.Builder
GetUsagePlanResponse.Builder
GetUsagePlansRequest.Builder
GetUsagePlansResponse.Builder
GetUsageRequest.Builder
GetUsageResponse.Builder
GetVpcLinkRequest.Builder
GetVpcLinkResponse.Builder
GetVpcLinksRequest.Builder
GetVpcLinksResponse.Builder
ImportApiKeysRequest.Builder
ImportApiKeysResponse.Builder
ImportDocumentationPartsRequest.Builder
ImportDocumentationPartsResponse.Builder
ImportRestApiRequest.Builder
ImportRestApiResponse.Builder
Integration Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Integration.Builder
IntegrationResponse Represents an integration response.
IntegrationResponse.Builder
IntegrationType The integration type.
LimitExceededException.Builder
LocationStatusType
Method Represents a client-facing interface by which the client calls the API to access back-end resources.
Method.Builder
MethodResponse Represents a method response of a given HTTP status code returned to the client.
MethodResponse.Builder
MethodSetting Specifies the method setting properties.
MethodSetting.Builder
MethodSnapshot Represents a summary of a Method resource, given a particular date and time.
MethodSnapshot.Builder
Model Represents the data structure of a method's request or response payload.
Model.Builder
MutualTlsAuthentication The mutual TLS authentication configuration for a custom domain name.
MutualTlsAuthentication.Builder
MutualTlsAuthenticationInput The mutual TLS authentication configuration for a custom domain name.
MutualTlsAuthenticationInput.Builder
NotFoundException.Builder
Op
PatchOperation For more information about supported patch operations, see Patch Operations.
PatchOperation.Builder
PutGatewayResponseRequest.Builder
PutGatewayResponseResponse.Builder
PutIntegrationRequest.Builder
PutIntegrationResponse.Builder
PutIntegrationResponseRequest.Builder
PutIntegrationResponseResponse.Builder
PutMethodRequest.Builder
PutMethodResponse.Builder
PutMethodResponseRequest.Builder
PutMethodResponseResponse.Builder
PutMode
PutRestApiRequest.Builder
PutRestApiResponse.Builder
QuotaPeriodType
QuotaSettings Quotas configured for a usage plan.
QuotaSettings.Builder
RequestValidator A set of validation rules for incoming Method requests.
RequestValidator.Builder
Resource Represents an API resource.
Resource.Builder
RestApi Represents a REST API.
RestApi.Builder
SdkConfigurationProperty A configuration property of an SDK type.
SdkConfigurationProperty.Builder
SdkType A type of SDK that API Gateway can generate.
SdkType.Builder
SecurityPolicy
ServiceUnavailableException.Builder
Stage Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Stage.Builder
StageKey A reference to a unique stage identified in the format {restApiId}/{stage}.
StageKey.Builder
TagResourceRequest.Builder
TagResourceResponse.Builder
TestInvokeAuthorizerRequest.Builder
TestInvokeAuthorizerResponse.Builder
TestInvokeMethodRequest.Builder
TestInvokeMethodResponse.Builder
ThrottleSettings The API request rate limits.
ThrottleSettings.Builder
TlsConfig Specifies the TLS configuration for an integration.
TlsConfig.Builder
TooManyRequestsException.Builder
UnauthorizedCacheControlHeaderStrategy
UnauthorizedException.Builder
UntagResourceRequest.Builder
UntagResourceResponse.Builder
UpdateAccountRequest.Builder
UpdateAccountResponse.Builder
UpdateApiKeyRequest.Builder
UpdateApiKeyResponse.Builder
UpdateAuthorizerRequest.Builder
UpdateAuthorizerResponse.Builder
UpdateBasePathMappingRequest.Builder
UpdateBasePathMappingResponse.Builder
UpdateClientCertificateRequest.Builder
UpdateClientCertificateResponse.Builder
UpdateDeploymentRequest.Builder
UpdateDeploymentResponse.Builder
UpdateDocumentationPartRequest.Builder
UpdateDocumentationPartResponse.Builder
UpdateDocumentationVersionRequest.Builder
UpdateDocumentationVersionResponse.Builder
UpdateDomainNameRequest.Builder
UpdateDomainNameResponse.Builder
UpdateGatewayResponseRequest.Builder
UpdateGatewayResponseResponse.Builder
UpdateIntegrationRequest.Builder
UpdateIntegrationResponse.Builder
UpdateIntegrationResponseRequest.Builder
UpdateIntegrationResponseResponse.Builder
UpdateMethodRequest.Builder
UpdateMethodResponse.Builder
UpdateMethodResponseRequest.Builder
UpdateMethodResponseResponse.Builder
UpdateModelRequest.Builder
UpdateModelResponse.Builder
UpdateRequestValidatorRequest.Builder
UpdateRequestValidatorResponse.Builder
UpdateResourceRequest.Builder
UpdateResourceResponse.Builder
UpdateRestApiRequest.Builder
UpdateRestApiResponse.Builder
UpdateStageRequest.Builder
UpdateStageResponse.Builder
UpdateUsagePlanRequest.Builder
UpdateUsagePlanResponse.Builder
UpdateUsageRequest.Builder
UpdateUsageResponse.Builder
UpdateVpcLinkRequest.Builder
UpdateVpcLinkResponse.Builder
UsagePlan Represents a usage plan used to specify who can assess associated API stages.
UsagePlan.Builder
UsagePlanKey Represents a usage plan key to identify a plan customer.
UsagePlanKey.Builder
VpcLink An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
VpcLink.Builder
VpcLinkStatus

Classes in software.amazon.awssdk.services.apigateway.model used by software.amazon.awssdk.services.apigateway.paginators

Class and Description
ApiKey A resource that can be distributed to callers for executing Method resources that require an API key.
BasePathMapping Represents the base path that callers of the API must provide as part of the URL after the domain name.
ClientCertificate Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Deployment An immutable representation of a RestApi resource that can be called by users using Stages.
DomainName Represents a custom domain name as a user-friendly host name of an API (RestApi).
GetApiKeysRequest A request to get information about the current ApiKeys resource.
GetApiKeysResponse Represents a collection of API keys as represented by an ApiKeys resource.
GetBasePathMappingsRequest A request to get information about a collection of BasePathMapping resources.
GetBasePathMappingsResponse Represents a collection of BasePathMapping resources.
GetClientCertificatesRequest A request to get information about a collection of ClientCertificate resources.
GetClientCertificatesResponse Represents a collection of ClientCertificate resources.
GetDeploymentsRequest Requests API Gateway to get information about a Deployments collection.
GetDeploymentsResponse Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection.
GetDomainNamesRequest Request to describe a collection of DomainName resources.
GetDomainNamesResponse Represents a collection of DomainName resources.
GetModelsRequest Request to list existing Models defined for a RestApi resource.
GetModelsResponse Represents a collection of Model resources.
GetResourcesRequest Request to list information about a collection of resources.
GetResourcesResponse Represents a collection of Resource resources.
GetRestApisRequest The GET request to list existing RestApis defined for your collection.
GetRestApisResponse Contains references to your APIs and links that guide you in how to interact with your collection.
GetUsagePlanKeysRequest The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
GetUsagePlanKeysResponse Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
GetUsagePlansRequest The GET request to get all the usage plans of the caller's account.
GetUsagePlansResponse Represents a collection of usage plans for an AWS account.
GetUsageRequest The GET request to get the usage data of a usage plan in a specified time interval.
GetUsageResponse Represents the usage data of a usage plan.
GetVpcLinksRequest Gets the VpcLinks collection under the caller's account in a selected region.
GetVpcLinksResponse The collection of VPC links under the caller's account in a region.
Model Represents the data structure of a method's request or response payload.
Resource Represents an API resource.
RestApi Represents a REST API.
UsagePlan Represents a usage plan used to specify who can assess associated API stages.
UsagePlanKey Represents a usage plan key to identify a plan customer.
VpcLink An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

Classes in software.amazon.awssdk.services.apigateway.model used by software.amazon.awssdk.services.apigateway.transform

Class and Description
CreateApiKeyRequest Request to create an ApiKey resource.
CreateAuthorizerRequest Request to add a new Authorizer to an existing RestApi resource.
CreateBasePathMappingRequest Requests API Gateway to create a new BasePathMapping resource.
CreateDeploymentRequest Requests API Gateway to create a Deployment resource.
CreateDocumentationPartRequest Creates a new documentation part of a given API.
CreateDocumentationVersionRequest Creates a new documentation version of a given API.
CreateDomainNameRequest A request to create a new domain name.
CreateModelRequest Request to add a new Model to an existing RestApi resource.
CreateRequestValidatorRequest Creates a RequestValidator of a given RestApi.
CreateResourceRequest Requests API Gateway to create a Resource resource.
CreateRestApiRequest The POST Request to add a new RestApi resource to your collection.
CreateStageRequest Requests API Gateway to create a Stage resource.
CreateUsagePlanKeyRequest The POST request to create a usage plan key for adding an existing API key to a usage plan.
CreateUsagePlanRequest The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
CreateVpcLinkRequest Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.
DeleteApiKeyRequest A request to delete the ApiKey resource.
DeleteAuthorizerRequest Request to delete an existing Authorizer resource.
DeleteBasePathMappingRequest A request to delete the BasePathMapping resource.
DeleteClientCertificateRequest A request to delete the ClientCertificate resource.
DeleteDeploymentRequest Requests API Gateway to delete a Deployment resource.
DeleteDocumentationPartRequest Deletes an existing documentation part of an API.
DeleteDocumentationVersionRequest Deletes an existing documentation version of an API.
DeleteDomainNameRequest A request to delete the DomainName resource.
DeleteGatewayResponseRequest Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
DeleteIntegrationRequest Represents a delete integration request.
DeleteIntegrationResponseRequest Represents a delete integration response request.
DeleteMethodRequest Request to delete an existing Method resource.
DeleteMethodResponseRequest A request to delete an existing MethodResponse resource.
DeleteModelRequest Request to delete an existing model in an existing RestApi resource.
DeleteRequestValidatorRequest Deletes a specified RequestValidator of a given RestApi.
DeleteResourceRequest Request to delete a Resource.
DeleteRestApiRequest Request to delete the specified API from your collection.
DeleteStageRequest Requests API Gateway to delete a Stage resource.
DeleteUsagePlanKeyRequest The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
DeleteUsagePlanRequest The DELETE request to delete a usage plan of a given plan Id.
DeleteVpcLinkRequest Deletes an existing VpcLink of a specified identifier.
FlushStageAuthorizersCacheRequest Request to flush authorizer cache entries on a specified stage.
FlushStageCacheRequest Requests API Gateway to flush a stage's cache.
GenerateClientCertificateRequest A request to generate a ClientCertificate resource.
GetAccountRequest Requests API Gateway to get information about the current Account resource.
GetApiKeyRequest A request to get information about the current ApiKey resource.
GetApiKeysRequest A request to get information about the current ApiKeys resource.
GetAuthorizerRequest Request to describe an existing Authorizer resource.
GetAuthorizersRequest Request to describe an existing Authorizers resource.
GetBasePathMappingRequest Request to describe a BasePathMapping resource.
GetBasePathMappingsRequest A request to get information about a collection of BasePathMapping resources.
GetClientCertificateRequest A request to get information about the current ClientCertificate resource.
GetClientCertificatesRequest A request to get information about a collection of ClientCertificate resources.
GetDeploymentRequest Requests API Gateway to get information about a Deployment resource.
GetDeploymentsRequest Requests API Gateway to get information about a Deployments collection.
GetDocumentationPartRequest Gets a specified documentation part of a given API.
GetDocumentationPartsRequest Gets the documentation parts of an API.
GetDocumentationVersionRequest Gets a documentation snapshot of an API.
GetDocumentationVersionsRequest Gets the documentation versions of an API.
GetDomainNameRequest Request to get the name of a DomainName resource.
GetDomainNamesRequest Request to describe a collection of DomainName resources.
GetExportRequest Request a new export of a RestApi for a particular Stage.
GetGatewayResponseRequest Gets a GatewayResponse of a specified response type on the given RestApi.
GetGatewayResponsesRequest Gets the GatewayResponses collection on the given RestApi.
GetIntegrationRequest Represents a request to get the integration configuration.
GetIntegrationResponseRequest Represents a get integration response request.
GetMethodRequest Request to describe an existing Method resource.
GetMethodResponseRequest Request to describe a MethodResponse resource.
GetModelRequest Request to list information about a model in an existing RestApi resource.
GetModelsRequest Request to list existing Models defined for a RestApi resource.
GetModelTemplateRequest Request to generate a sample mapping template used to transform the payload.
GetRequestValidatorRequest Gets a RequestValidator of a given RestApi.
GetRequestValidatorsRequest Gets the RequestValidators collection of a given RestApi.
GetResourceRequest Request to list information about a resource.
GetResourcesRequest Request to list information about a collection of resources.
GetRestApiRequest The GET request to list an existing RestApi defined for your collection.
GetRestApisRequest The GET request to list existing RestApis defined for your collection.
GetSdkRequest Request a new generated client SDK for a RestApi and Stage.
GetSdkTypeRequest Get an SdkType instance.
GetSdkTypesRequest Get the SdkTypes collection.
GetStageRequest Requests API Gateway to get information about a Stage resource.
GetStagesRequest Requests API Gateway to get information about one or more Stage resources.
GetTagsRequest Gets the Tags collection for a given resource.
GetUsagePlanKeyRequest The GET request to get a usage plan key of a given key identifier.
GetUsagePlanKeysRequest The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
GetUsagePlanRequest The GET request to get a usage plan of a given plan identifier.
GetUsagePlansRequest The GET request to get all the usage plans of the caller's account.
GetUsageRequest The GET request to get the usage data of a usage plan in a specified time interval.
GetVpcLinkRequest Gets a specified VPC link under the caller's account in a region.
GetVpcLinksRequest Gets the VpcLinks collection under the caller's account in a selected region.
ImportApiKeysRequest The POST request to import API keys from an external source, such as a CSV-formatted file.
ImportDocumentationPartsRequest Import documentation parts from an external (e.g., OpenAPI) definition file.
ImportRestApiRequest A POST request to import an API to API Gateway using an input of an API definition file.
PutGatewayResponseRequest Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
PutIntegrationRequest Sets up a method's integration.
PutIntegrationResponseRequest Represents a put integration response request.
PutMethodRequest Request to add a method to an existing Resource resource.
PutMethodResponseRequest Request to add a MethodResponse to an existing Method resource.
PutRestApiRequest A PUT request to update an existing API, with external API definitions specified as the request body.
TagResourceRequest Adds or updates a tag on a given resource.
TestInvokeAuthorizerRequest Make a request to simulate the invocation of an Authorizer.
TestInvokeMethodRequest Make a request to simulate the invocation of a Method.
UntagResourceRequest Removes a tag from a given resource.
UpdateAccountRequest Requests API Gateway to change information about the current Account resource.
UpdateApiKeyRequest A request to change information about an ApiKey resource.
UpdateAuthorizerRequest Request to update an existing Authorizer resource.
UpdateBasePathMappingRequest A request to change information about the BasePathMapping resource.
UpdateClientCertificateRequest A request to change information about an ClientCertificate resource.
UpdateDeploymentRequest Requests API Gateway to change information about a Deployment resource.
UpdateDocumentationPartRequest Updates an existing documentation part of a given API.
UpdateDocumentationVersionRequest Updates an existing documentation version of an API.
UpdateDomainNameRequest A request to change information about the DomainName resource.
UpdateGatewayResponseRequest Updates a GatewayResponse of a specified response type on the given RestApi.
UpdateIntegrationRequest Represents an update integration request.
UpdateIntegrationResponseRequest Represents an update integration response request.
UpdateMethodRequest Request to update an existing Method resource.
UpdateMethodResponseRequest A request to update an existing MethodResponse resource.
UpdateModelRequest Request to update an existing model in an existing RestApi resource.
UpdateRequestValidatorRequest Updates a RequestValidator of a given RestApi.
UpdateResourceRequest Request to change information about a Resource resource.
UpdateRestApiRequest Request to update an existing RestApi resource in your collection.
UpdateStageRequest Requests API Gateway to change information about a Stage resource.
UpdateUsagePlanRequest The PATCH request to update a usage plan of a given plan Id.
UpdateUsageRequest The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
UpdateVpcLinkRequest Updates an existing VpcLink of a specified identifier.