All Classes and Interfaces
Class
Description
Access log settings, including the access log format and access log destination ARN.
Service client for accessing Amazon API Gateway asynchronously.
A builder for creating an instance of
ApiGatewayAsyncClient.The parameters object used to resolve the auth schemes for the ApiGateway service.
A builder for a
ApiGatewayAuthSchemeParams.An auth scheme provider for ApiGateway service.
This includes configuration specific to Amazon API Gateway that is supported by both
ApiGatewayClientBuilder
and ApiGatewayAsyncClientBuilder.Service client for accessing Amazon API Gateway.
A builder for creating an instance of
ApiGatewayClient.The parameters object used to resolve an endpoint for the ApiGateway service.
An endpoint provider for ApiGateway.
Class to expose the service client settings to the user.
A builder for creating a
ApiGatewayServiceClientConfiguration
A resource that can be distributed to callers for executing Method resources that require an API key.
API stage name of the associated API stage in a usage plan.
An AWS Arn.
Represents an authorization layer for methods.
The authorizer type.
The submitted request is not valid, for example, the input is incomplete or incorrect.
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Returns the status of the CacheCluster.
Configuration settings of a canary deployment.
Represents a client certificate used to configure client-side SSL authentication while sending requests to the
integration endpoint.
The request configuration has conflicts.
Request to create an ApiKey resource.
CreateApiKeyRequest Marshaller
A resource that can be distributed to callers for executing Method resources that require an API key.
Request to add a new Authorizer to an existing RestApi resource.
CreateAuthorizerRequest Marshaller
Represents an authorization layer for methods.
Requests API Gateway to create a new BasePathMapping resource.
CreateBasePathMappingRequest Marshaller
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Requests API Gateway to create a Deployment resource.
CreateDeploymentRequest Marshaller
An immutable representation of a RestApi resource that can be called by users using Stages.
Creates a new documentation part of a given API.
CreateDocumentationPartRequest Marshaller
A documentation part for a targeted API entity.
Creates a new documentation version of a given API.
CreateDocumentationVersionRequest Marshaller
A snapshot of the documentation of an API.
CreateDomainNameAccessAssociationRequest Marshaller
Represents a domain name access association between an access association source and a private custom domain name.
A request to create a new domain name.
CreateDomainNameRequest Marshaller
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Request to add a new Model to an existing RestApi resource.
CreateModelRequest Marshaller
Represents the data structure of a method's request or response payload.
Creates a RequestValidator of a given RestApi.
CreateRequestValidatorRequest Marshaller
A set of validation rules for incoming Method requests.
Requests API Gateway to create a Resource resource.
CreateResourceRequest Marshaller
Represents an API resource.
The POST Request to add a new RestApi resource to your collection.
CreateRestApiRequest Marshaller
Represents a REST API.
Requests API Gateway to create a Stage resource.
CreateStageRequest Marshaller
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
The POST request to create a usage plan key for adding an existing API key to a usage plan.
CreateUsagePlanKeyRequest Marshaller
Represents a usage plan key to identify a plan customer.
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 Marshaller
Represents a usage plan used to specify who can assess associated API stages.
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 Marshaller
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
A request to delete the ApiKey resource.
DeleteApiKeyRequest Marshaller
Request to delete an existing Authorizer resource.
DeleteAuthorizerRequest Marshaller
A request to delete the BasePathMapping resource.
DeleteBasePathMappingRequest Marshaller
A request to delete the ClientCertificate resource.
DeleteClientCertificateRequest Marshaller
Requests API Gateway to delete a Deployment resource.
DeleteDeploymentRequest Marshaller
Deletes an existing documentation part of an API.
DeleteDocumentationPartRequest Marshaller
Deletes an existing documentation version of an API.
DeleteDocumentationVersionRequest MarshallerDeleteDomainNameAccessAssociationRequest Marshaller
A request to delete the DomainName resource.
DeleteDomainNameRequest Marshaller
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with
the default settings.
DeleteGatewayResponseRequest Marshaller
Represents a delete integration request.
DeleteIntegrationRequest Marshaller
Represents a delete integration response request.
DeleteIntegrationResponseRequest Marshaller
Request to delete an existing Method resource.
DeleteMethodRequest Marshaller
A request to delete an existing MethodResponse resource.
DeleteMethodResponseRequest Marshaller
Request to delete an existing model in an existing RestApi resource.
DeleteModelRequest Marshaller
Deletes a specified RequestValidator of a given RestApi.
DeleteRequestValidatorRequest Marshaller
Request to delete a Resource.
DeleteResourceRequest Marshaller
Request to delete the specified API from your collection.
DeleteRestApiRequest Marshaller
Requests API Gateway to delete a Stage resource.
DeleteStageRequest Marshaller
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
DeleteUsagePlanKeyRequest Marshaller
The DELETE request to delete a usage plan of a given plan Id.
DeleteUsagePlanRequest Marshaller
Deletes an existing VpcLink of a specified identifier.
DeleteVpcLinkRequest Marshaller
An immutable representation of a RestApi resource that can be called by users using Stages.
The input configuration for a canary deployment.
A documentation part for a targeted API entity.
Specifies the target API entity to which the documentation applies.
A snapshot of the documentation of an API.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Represents a domain name access association between an access association source and a private custom domain name.
Link between an endpoint property and the
AwsEndpointAttribute it represents.
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName)
has and the IP address types that can invoke it.
The endpoint type.
Request to flush authorizer cache entries on a specified stage.
FlushStageAuthorizersCacheRequest Marshaller
Requests API Gateway to flush a stage's cache.
FlushStageCacheRequest Marshaller
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
A request to generate a ClientCertificate resource.
GenerateClientCertificateRequest Marshaller
Represents a client certificate used to configure client-side SSL authentication while sending requests to the
integration endpoint.
Requests API Gateway to get information about the current Account resource.
GetAccountRequest Marshaller
Represents an AWS account that is associated with API Gateway.
A request to get information about the current ApiKey resource.
GetApiKeyRequest Marshaller
A resource that can be distributed to callers for executing Method resources that require an API key.
Represents the output for the
ApiGatewayClient.getApiKeysPaginator(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getApiKeysPaginator(software.amazon.awssdk.services.apigateway.model.GetApiKeysRequest)
operation which is a paginated operation.
A request to get information about the current ApiKeys resource.
GetApiKeysRequest Marshaller
Represents a collection of API keys as represented by an ApiKeys resource.
Request to describe an existing Authorizer resource.
GetAuthorizerRequest Marshaller
Represents an authorization layer for methods.
Request to describe an existing Authorizers resource.
GetAuthorizersRequest Marshaller
Represents a collection of Authorizer resources.
Request to describe a BasePathMapping resource.
GetBasePathMappingRequest Marshaller
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Represents the output for the
ApiGatewayClient.getBasePathMappingsPaginator(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getBasePathMappingsPaginator(software.amazon.awssdk.services.apigateway.model.GetBasePathMappingsRequest)
operation which is a paginated operation.
A request to get information about a collection of BasePathMapping resources.
GetBasePathMappingsRequest Marshaller
Represents a collection of BasePathMapping resources.
A request to get information about the current ClientCertificate resource.
GetClientCertificateRequest Marshaller
Represents a client certificate used to configure client-side SSL authentication while sending requests to the
integration endpoint.
Represents the output for the
ApiGatewayClient.getClientCertificatesPaginator(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getClientCertificatesPaginator(software.amazon.awssdk.services.apigateway.model.GetClientCertificatesRequest)
operation which is a paginated operation.
A request to get information about a collection of ClientCertificate resources.
GetClientCertificatesRequest Marshaller
Represents a collection of ClientCertificate resources.
Requests API Gateway to get information about a Deployment resource.
GetDeploymentRequest Marshaller
An immutable representation of a RestApi resource that can be called by users using Stages.
Represents the output for the
ApiGatewayClient.getDeploymentsPaginator(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getDeploymentsPaginator(software.amazon.awssdk.services.apigateway.model.GetDeploymentsRequest)
operation which is a paginated operation.
Requests API Gateway to get information about a Deployments collection.
GetDeploymentsRequest Marshaller
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.
Gets a specified documentation part of a given API.
GetDocumentationPartRequest Marshaller
A documentation part for a targeted API entity.
Gets the documentation parts of an API.
GetDocumentationPartsRequest Marshaller
The collection of documentation parts of an API.
Gets a documentation snapshot of an API.
GetDocumentationVersionRequest Marshaller
A snapshot of the documentation of an API.
Gets the documentation versions of an API.
GetDocumentationVersionsRequest Marshaller
The collection of documentation snapshots of an API.
GetDomainNameAccessAssociationsRequest Marshaller
Request to get the name of a DomainName resource.
GetDomainNameRequest Marshaller
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Represents the output for the
ApiGatewayClient.getDomainNamesPaginator(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getDomainNamesPaginator(software.amazon.awssdk.services.apigateway.model.GetDomainNamesRequest)
operation which is a paginated operation.
Request to describe a collection of DomainName resources.
GetDomainNamesRequest Marshaller
Represents a collection of DomainName resources.
Request a new export of a RestApi for a particular Stage.
GetExportRequest Marshaller
The binary blob response to GetExport, which contains the generated SDK.
Gets a GatewayResponse of a specified response type on the given RestApi.
GetGatewayResponseRequest Marshaller
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Gets the GatewayResponses collection on the given RestApi.
GetGatewayResponsesRequest Marshaller
The collection of the GatewayResponse instances of a RestApi as a
responseType-to-GatewayResponse object
map of key-value pairs.
Represents a request to get the integration configuration.
GetIntegrationRequest Marshaller
Represents an
HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock
integration.
Represents a get integration response request.
GetIntegrationResponseRequest Marshaller
Represents an integration response.
Request to describe an existing Method resource.
GetMethodRequest Marshaller
Represents a client-facing interface by which the client calls the API to access back-end resources.
Request to describe a MethodResponse resource.
GetMethodResponseRequest Marshaller
Represents a method response of a given HTTP status code returned to the client.
Request to list information about a model in an existing RestApi resource.
GetModelRequest Marshaller
Represents the data structure of a method's request or response payload.
Represents the output for the
ApiGatewayClient.getModelsPaginator(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getModelsPaginator(software.amazon.awssdk.services.apigateway.model.GetModelsRequest)
operation which is a paginated operation.
Request to list existing Models defined for a RestApi resource.
GetModelsRequest Marshaller
Represents a collection of Model resources.
Request to generate a sample mapping template used to transform the payload.
GetModelTemplateRequest Marshaller
Represents a mapping template used to transform a payload.
Gets a RequestValidator of a given RestApi.
GetRequestValidatorRequest Marshaller
A set of validation rules for incoming Method requests.
Gets the RequestValidators collection of a given RestApi.
GetRequestValidatorsRequest Marshaller
A collection of RequestValidator resources of a given RestApi.
Request to list information about a resource.
GetResourceRequest Marshaller
Represents an API resource.
Represents the output for the
ApiGatewayClient.getResourcesPaginator(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getResourcesPaginator(software.amazon.awssdk.services.apigateway.model.GetResourcesRequest)
operation which is a paginated operation.
Request to list information about a collection of resources.
GetResourcesRequest Marshaller
Represents a collection of Resource resources.
The GET request to list an existing RestApi defined for your collection.
GetRestApiRequest Marshaller
Represents a REST API.
Represents the output for the
ApiGatewayClient.getRestApisPaginator(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getRestApisPaginator(software.amazon.awssdk.services.apigateway.model.GetRestApisRequest)
operation which is a paginated operation.
The GET request to list existing RestApis defined for your collection.
GetRestApisRequest Marshaller
Contains references to your APIs and links that guide you in how to interact with your collection.
Request a new generated client SDK for a RestApi and Stage.
GetSdkRequest Marshaller
The binary blob response to GetSdk, which contains the generated SDK.
Get an SdkType instance.
GetSdkTypeRequest Marshaller
A type of SDK that API Gateway can generate.
Get the SdkTypes collection.
GetSdkTypesRequest Marshaller
The collection of SdkType instances.
Requests API Gateway to get information about a Stage resource.
GetStageRequest Marshaller
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Requests API Gateway to get information about one or more Stage resources.
GetStagesRequest Marshaller
A list of Stage resources that are associated with the ApiKey resource.
Gets the Tags collection for a given resource.
GetTagsRequest Marshaller
The collection of tags.
Represents the output for the
ApiGatewayClient.getUsagePaginator(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)
operation which is a paginated operation.
The GET request to get a usage plan key of a given key identifier.
GetUsagePlanKeyRequest Marshaller
Represents a usage plan key to identify a plan customer.
Represents the output for the
ApiGatewayClient.getUsagePlanKeysPaginator(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getUsagePlanKeysPaginator(software.amazon.awssdk.services.apigateway.model.GetUsagePlanKeysRequest)
operation which is a paginated operation.
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
GetUsagePlanKeysRequest Marshaller
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other
types of keys.
The GET request to get a usage plan of a given plan identifier.
GetUsagePlanRequest Marshaller
Represents a usage plan used to specify who can assess associated API stages.
Represents the output for the
ApiGatewayClient.getUsagePlansPaginator(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getUsagePlansPaginator(software.amazon.awssdk.services.apigateway.model.GetUsagePlansRequest)
operation which is a paginated operation.
The GET request to get all the usage plans of the caller's account.
GetUsagePlansRequest Marshaller
Represents a collection of usage plans for an AWS account.
Represents the output for the
ApiGatewayAsyncClient.getUsagePaginator(software.amazon.awssdk.services.apigateway.model.GetUsageRequest)
operation which is a paginated operation.
The GET request to get the usage data of a usage plan in a specified time interval.
GetUsageRequest Marshaller
Represents the usage data of a usage plan.
Gets a specified VPC link under the caller's account in a region.
GetVpcLinkRequest Marshaller
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Represents the output for the
ApiGatewayClient.getVpcLinksPaginator(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)
operation which is a paginated operation.
Represents the output for the
ApiGatewayAsyncClient.getVpcLinksPaginator(software.amazon.awssdk.services.apigateway.model.GetVpcLinksRequest)
operation which is a paginated operation.
Gets the VpcLinks collection under the caller's account in a selected region.
GetVpcLinksRequest Marshaller
The collection of VPC links under the caller's account in a region.
Identifiers for variables declared within the rule engine, e.g.
The POST request to import API keys from an external source, such as a CSV-formatted file.
ImportApiKeysRequest Marshaller
The identifier of an ApiKey used in a UsagePlan.
Import documentation parts from an external (e.g., OpenAPI) definition file.
ImportDocumentationPartsRequest Marshaller
A collection of the imported DocumentationPart identifiers.
A POST request to import an API to API Gateway using an input of an API definition file.
ImportRestApiRequest Marshaller
Represents a REST API.
Represents an
HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock
integration.
Represents an integration response.
The integration type.
The request exceeded the rate limit.
Represents a client-facing interface by which the client calls the API to access back-end resources.
Represents a method response of a given HTTP status code returned to the client.
Specifies the method setting properties.
Represents a summary of a Method resource, given a particular date and time.
Represents the data structure of a method's request or response payload.
The mutual TLS authentication configuration for a custom domain name.
The mutual TLS authentication configuration for a custom domain name.
The requested resource is not found.
For more information about supported patch operations, see Patch Operations.
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
PutGatewayResponseRequest Marshaller
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Sets up a method's integration.
PutIntegrationRequest Marshaller
Represents an
HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock
integration.
Represents a put integration response request.
PutIntegrationResponseRequest Marshaller
Represents an integration response.
Request to add a method to an existing Resource resource.
PutMethodRequest Marshaller
Represents a client-facing interface by which the client calls the API to access back-end resources.
Request to add a MethodResponse to an existing Method resource.
PutMethodResponseRequest Marshaller
Represents a method response of a given HTTP status code returned to the client.
A PUT request to update an existing API, with external API definitions specified as the request body.
PutRestApiRequest Marshaller
Represents a REST API.
Quotas configured for a usage plan.
RejectDomainNameAccessAssociationRequest Marshaller
A set of validation rules for incoming Method requests.
Represents an API resource.
Represents a REST API.
Represents a URL to be used internally for endpoint resolution.
A configuration property of an SDK type.
A type of SDK that API Gateway can generate.
The requested service is not available.
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
A reference to a unique stage identified in the format
{restApiId}/{stage}.
Adds or updates a tag on a given resource.
TagResourceRequest Marshaller
Make a request to simulate the invocation of an Authorizer.
TestInvokeAuthorizerRequest Marshaller
Represents the response of the test invoke request for a custom Authorizer
Make a request to simulate the invocation of a Method.
TestInvokeMethodRequest Marshaller
Represents the response of the test invoke request in the HTTP method.
The API request rate limits.
Specifies the TLS configuration for an integration.
The request has reached its throttling limit.
The request is denied because the caller has insufficient permissions.
Removes a tag from a given resource.
UntagResourceRequest Marshaller
Requests API Gateway to change information about the current Account resource.
UpdateAccountRequest Marshaller
Represents an AWS account that is associated with API Gateway.
A request to change information about an ApiKey resource.
UpdateApiKeyRequest Marshaller
A resource that can be distributed to callers for executing Method resources that require an API key.
Request to update an existing Authorizer resource.
UpdateAuthorizerRequest Marshaller
Represents an authorization layer for methods.
A request to change information about the BasePathMapping resource.
UpdateBasePathMappingRequest Marshaller
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A request to change information about an ClientCertificate resource.
UpdateClientCertificateRequest Marshaller
Represents a client certificate used to configure client-side SSL authentication while sending requests to the
integration endpoint.
Requests API Gateway to change information about a Deployment resource.
UpdateDeploymentRequest Marshaller
An immutable representation of a RestApi resource that can be called by users using Stages.
Updates an existing documentation part of a given API.
UpdateDocumentationPartRequest Marshaller
A documentation part for a targeted API entity.
Updates an existing documentation version of an API.
UpdateDocumentationVersionRequest Marshaller
A snapshot of the documentation of an API.
A request to change information about the DomainName resource.
UpdateDomainNameRequest Marshaller
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Updates a GatewayResponse of a specified response type on the given RestApi.
UpdateGatewayResponseRequest Marshaller
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Represents an update integration request.
UpdateIntegrationRequest Marshaller
Represents an
HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock
integration.
Represents an update integration response request.
UpdateIntegrationResponseRequest Marshaller
Represents an integration response.
Request to update an existing Method resource.
UpdateMethodRequest Marshaller
Represents a client-facing interface by which the client calls the API to access back-end resources.
A request to update an existing MethodResponse resource.
UpdateMethodResponseRequest Marshaller
Represents a method response of a given HTTP status code returned to the client.
Request to update an existing model in an existing RestApi resource.
UpdateModelRequest Marshaller
Represents the data structure of a method's request or response payload.
Updates a RequestValidator of a given RestApi.
UpdateRequestValidatorRequest Marshaller
A set of validation rules for incoming Method requests.
Request to change information about a Resource resource.
UpdateResourceRequest Marshaller
Represents an API resource.
Request to update an existing RestApi resource in your collection.
UpdateRestApiRequest Marshaller
Represents a REST API.
Requests API Gateway to change information about a Stage resource.
UpdateStageRequest Marshaller
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
The PATCH request to update a usage plan of a given plan Id.
UpdateUsagePlanRequest Marshaller
Represents a usage plan used to specify who can assess associated API stages.
The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified
API key.
UpdateUsageRequest Marshaller
Represents the usage data of a usage plan.
Updates an existing VpcLink of a specified identifier.
UpdateVpcLinkRequest Marshaller
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
Represents a usage plan used to specify who can assess associated API stages.
Represents a usage plan key to identify a plan customer.
Base class for the types of values computable by the
RuleEngine.An array value.
A boolean value.
An integer value.
A record (map) value.
A string value.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).