AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessLogSettings |
Access log settings, including the access log format and access log destination ARN. |
|
APIGatewayPaginatorFactory |
Paginators for the APIGateway service |
|
ApiKey |
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. |
|
ApiStage |
API stage name of the associated API stage in a usage plan. |
|
Authorizer |
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. |
|
BadRequestException |
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details. |
|
BasePathMapping |
Represents the base path that callers of the API must provide as part of the URL after the domain name. |
|
CanarySettings |
Configuration settings of a canary deployment. |
|
ClientCertificate |
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint. |
|
ConflictException |
The request configuration has conflicts. For details, see the accompanying error message. |
|
CreateApiKeyRequest |
Container for the parameters to the CreateApiKey operation. Create an ApiKey resource. |
|
CreateApiKeyResponse |
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. |
|
CreateAuthorizerRequest |
Container for the parameters to the CreateAuthorizer operation. Adds a new Authorizer resource to an existing RestApi resource. |
|
CreateAuthorizerResponse |
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. |
|
CreateBasePathMappingRequest |
Container for the parameters to the CreateBasePathMapping operation. Creates a new BasePathMapping resource. |
|
CreateBasePathMappingResponse |
Represents the base path that callers of the API must provide as part of the URL after the domain name. |
|
CreateDeploymentRequest |
Container for the parameters to the CreateDeployment operation. Creates a Deployment resource, which makes a specified RestApi callable over the internet. |
|
CreateDeploymentResponse |
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. |
|
CreateDocumentationPartRequest |
Container for the parameters to the CreateDocumentationPart operation. Creates a documentation part. |
|
CreateDocumentationPartResponse |
A documentation part for a targeted API entity. |
|
CreateDocumentationVersionRequest |
Container for the parameters to the CreateDocumentationVersion operation. Creates a documentation version |
|
CreateDocumentationVersionResponse |
A snapshot of the documentation of an API. |
|
CreateDomainNameRequest |
Container for the parameters to the CreateDomainName operation. Creates a new domain name. |
|
CreateDomainNameResponse |
Represents a custom domain name as a user-friendly host name of an API (RestApi). |
|
CreateModelRequest |
Container for the parameters to the CreateModel operation. Adds a new Model resource to an existing RestApi resource. |
|
CreateModelResponse |
Represents the data structure of a method's request or response payload. |
|
CreateRequestValidatorRequest |
Container for the parameters to the CreateRequestValidator operation. Creates a RequestValidator of a given RestApi. |
|
CreateRequestValidatorResponse |
A set of validation rules for incoming Method requests. |
|
CreateResourceRequest |
Container for the parameters to the CreateResource operation. Creates a Resource resource. |
|
CreateResourceResponse |
Represents an API resource. |
|
CreateRestApiRequest |
Container for the parameters to the CreateRestApi operation. Creates a new RestApi resource. |
|
CreateRestApiResponse |
Represents a REST API. |
|
CreateStageRequest |
Container for the parameters to the CreateStage operation. Creates a new Stage resource that references a pre-existing Deployment for the API. |
|
CreateStageResponse |
Represents a unique identifier for a version of a deployed RestApi that is callable by users. |
|
CreateUsagePlanKeyRequest |
Container for the parameters to the CreateUsagePlanKey operation. Creates a usage plan key for adding an existing API key to a usage plan. |
|
CreateUsagePlanKeyResponse |
Represents a usage plan key to identify a plan customer. |
|
CreateUsagePlanRequest |
Container for the parameters to the CreateUsagePlan operation. Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. |
|
CreateUsagePlanResponse |
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests. |
|
CreateVpcLinkRequest |
Container for the parameters to the CreateVpcLink operation. 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. The caller must have permissions to create and update VPC Endpoint services. |
|
CreateVpcLinkResponse |
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). |
|
DeleteApiKeyRequest |
Container for the parameters to the DeleteApiKey operation. Deletes the ApiKey resource. |
|
DeleteApiKeyResponse |
This is the response object from the DeleteApiKey operation. |
|
DeleteAuthorizerRequest |
Container for the parameters to the DeleteAuthorizer operation. Deletes an existing Authorizer resource. |
|
DeleteAuthorizerResponse |
This is the response object from the DeleteAuthorizer operation. |
|
DeleteBasePathMappingRequest |
Container for the parameters to the DeleteBasePathMapping operation. Deletes the BasePathMapping resource. |
|
DeleteBasePathMappingResponse |
This is the response object from the DeleteBasePathMapping operation. |
|
DeleteClientCertificateRequest |
Container for the parameters to the DeleteClientCertificate operation. Deletes the ClientCertificate resource. |
|
DeleteClientCertificateResponse |
This is the response object from the DeleteClientCertificate operation. |
|
DeleteDeploymentRequest |
Container for the parameters to the DeleteDeployment operation. Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it. |
|
DeleteDeploymentResponse |
This is the response object from the DeleteDeployment operation. |
|
DeleteDocumentationPartRequest |
Container for the parameters to the DeleteDocumentationPart operation. Deletes a documentation part |
|
DeleteDocumentationPartResponse |
This is the response object from the DeleteDocumentationPart operation. |
|
DeleteDocumentationVersionRequest |
Container for the parameters to the DeleteDocumentationVersion operation. Deletes a documentation version. |
|
DeleteDocumentationVersionResponse |
This is the response object from the DeleteDocumentationVersion operation. |
|
DeleteDomainNameRequest |
Container for the parameters to the DeleteDomainName operation. Deletes the DomainName resource. |
|
DeleteDomainNameResponse |
This is the response object from the DeleteDomainName operation. |
|
DeleteGatewayResponseRequest |
Container for the parameters to the DeleteGatewayResponse operation. Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. |
|
DeleteGatewayResponseResponse |
This is the response object from the DeleteGatewayResponse operation. |
|
DeleteIntegrationRequest |
Container for the parameters to the DeleteIntegration operation. Represents a delete integration. |
|
DeleteIntegrationResponse |
This is the response object from the DeleteIntegration operation. |
|
DeleteIntegrationResponseRequest |
Container for the parameters to the DeleteIntegrationResponse operation. Represents a delete integration response. |
|
DeleteIntegrationResponseResponse |
This is the response object from the DeleteIntegrationResponse operation. |
|
DeleteMethodRequest |
Container for the parameters to the DeleteMethod operation. Deletes an existing Method resource. |
|
DeleteMethodResponse |
This is the response object from the DeleteMethod operation. |
|
DeleteMethodResponseRequest |
Container for the parameters to the DeleteMethodResponse operation. Deletes an existing MethodResponse resource. |
|
DeleteMethodResponseResponse |
This is the response object from the DeleteMethodResponse operation. |
|
DeleteModelRequest |
Container for the parameters to the DeleteModel operation. Deletes a model. |
|
DeleteModelResponse |
This is the response object from the DeleteModel operation. |
|
DeleteRequestValidatorRequest |
Container for the parameters to the DeleteRequestValidator operation. Deletes a RequestValidator of a given RestApi. |
|
DeleteRequestValidatorResponse |
This is the response object from the DeleteRequestValidator operation. |
|
DeleteResourceRequest |
Container for the parameters to the DeleteResource operation. Deletes a Resource resource. |
|
DeleteResourceResponse |
This is the response object from the DeleteResource operation. |
|
DeleteRestApiRequest |
Container for the parameters to the DeleteRestApi operation. Deletes the specified API. |
|
DeleteRestApiResponse |
This is the response object from the DeleteRestApi operation. |
|
DeleteStageRequest |
Container for the parameters to the DeleteStage operation. Deletes a Stage resource. |
|
DeleteStageResponse |
This is the response object from the DeleteStage operation. |
|
DeleteUsagePlanKeyRequest |
Container for the parameters to the DeleteUsagePlanKey operation. Deletes a usage plan key and remove the underlying API key from the associated usage plan. |
|
DeleteUsagePlanKeyResponse |
This is the response object from the DeleteUsagePlanKey operation. |
|
DeleteUsagePlanRequest |
Container for the parameters to the DeleteUsagePlan operation. Deletes a usage plan of a given plan Id. |
|
DeleteUsagePlanResponse |
This is the response object from the DeleteUsagePlan operation. |
|
DeleteVpcLinkRequest |
Container for the parameters to the DeleteVpcLink operation. Deletes an existing VpcLink of a specified identifier. |
|
DeleteVpcLinkResponse |
This is the response object from the DeleteVpcLink operation. |
|
Deployment |
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. |
|
DeploymentCanarySettings |
The input configuration for a canary deployment. |
|
DocumentationPart |
A documentation part for a targeted API entity. |
|
DocumentationPartLocation |
Specifies the target API entity to which the documentation applies. |
|
DocumentationVersion |
A snapshot of the documentation of an API. |
|
DomainName |
Represents a custom domain name as a user-friendly host name of an API (RestApi). |
|
EndpointConfiguration |
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. |
|
FlushStageAuthorizersCacheRequest |
Container for the parameters to the FlushStageAuthorizersCache operation. Flushes all authorizer cache entries on a stage. |
|
FlushStageAuthorizersCacheResponse |
This is the response object from the FlushStageAuthorizersCache operation. |
|
FlushStageCacheRequest |
Container for the parameters to the FlushStageCache operation. Flushes a stage's cache. |
|
FlushStageCacheResponse |
This is the response object from the FlushStageCache operation. |
|
GatewayResponse |
A gateway response of a given response type and status code, with optional response parameters and mapping templates. |
|
GenerateClientCertificateRequest |
Container for the parameters to the GenerateClientCertificate operation. Generates a ClientCertificate resource. |
|
GenerateClientCertificateResponse |
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint. |
|
GetAccountRequest |
Container for the parameters to the GetAccount operation. Gets information about the current Account resource. |
|
GetAccountResponse |
Represents an AWS account that is associated with API Gateway. |
|
GetApiKeyRequest |
Container for the parameters to the GetApiKey operation. Gets information about the current ApiKey resource. |
|
GetApiKeyResponse |
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. |
|
GetApiKeysRequest |
Container for the parameters to the GetApiKeys operation. Gets information about the current ApiKeys resource. |
|
GetApiKeysResponse |
Represents a collection of API keys as represented by an ApiKeys resource. |
|
GetAuthorizerRequest |
Container for the parameters to the GetAuthorizer operation. Describe an existing Authorizer resource. |
|
GetAuthorizerResponse |
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. |
|
GetAuthorizersRequest |
Container for the parameters to the GetAuthorizers operation. Describe an existing Authorizers resource. |
|
GetAuthorizersResponse |
Represents a collection of Authorizer resources. |
|
GetBasePathMappingRequest |
Container for the parameters to the GetBasePathMapping operation. Describe a BasePathMapping resource. |
|
GetBasePathMappingResponse |
Represents the base path that callers of the API must provide as part of the URL after the domain name. |
|
GetBasePathMappingsRequest |
Container for the parameters to the GetBasePathMappings operation. Represents a collection of BasePathMapping resources. |
|
GetBasePathMappingsResponse |
Represents a collection of BasePathMapping resources. |
|
GetClientCertificateRequest |
Container for the parameters to the GetClientCertificate operation. Gets information about the current ClientCertificate resource. |
|
GetClientCertificateResponse |
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint. |
|
GetClientCertificatesRequest |
Container for the parameters to the GetClientCertificates operation. Gets a collection of ClientCertificate resources. |
|
GetClientCertificatesResponse |
Represents a collection of ClientCertificate resources. |
|
GetDeploymentRequest |
Container for the parameters to the GetDeployment operation. Gets information about a Deployment resource. |
|
GetDeploymentResponse |
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. |
|
GetDeploymentsRequest |
Container for the parameters to the GetDeployments operation. Gets 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. The collection offers a paginated view of the contained deployments. |
|
GetDocumentationPartRequest |
Container for the parameters to the GetDocumentationPart operation. Gets a documentation part. |
|
GetDocumentationPartResponse |
A documentation part for a targeted API entity. |
|
GetDocumentationPartsRequest |
Container for the parameters to the GetDocumentationParts operation. Gets documentation parts. |
|
GetDocumentationPartsResponse |
The collection of documentation parts of an API. |
|
GetDocumentationVersionRequest |
Container for the parameters to the GetDocumentationVersion operation. Gets a documentation version. |
|
GetDocumentationVersionResponse |
A snapshot of the documentation of an API. |
|
GetDocumentationVersionsRequest |
Container for the parameters to the GetDocumentationVersions operation. Gets documentation versions. |
|
GetDocumentationVersionsResponse |
The collection of documentation snapshots of an API. |
|
GetDomainNameRequest |
Container for the parameters to the GetDomainName operation. Represents a domain name that is contained in a simpler, more intuitive URL that can be called. |
|
GetDomainNameResponse |
Represents a custom domain name as a user-friendly host name of an API (RestApi). |
|
GetDomainNamesRequest |
Container for the parameters to the GetDomainNames operation. Represents a collection of DomainName resources. |
|
GetDomainNamesResponse |
Represents a collection of DomainName resources. |
|
GetExportRequest |
Container for the parameters to the GetExport operation. Exports a deployed version of a RestApi in a specified format. |
|
GetExportResponse |
The binary blob response to GetExport, which contains the generated SDK. |
|
GetGatewayResponseRequest |
Container for the parameters to the GetGatewayResponse operation. Gets a GatewayResponse of a specified response type on the given RestApi. |
|
GetGatewayResponseResponse |
A gateway response of a given response type and status code, with optional response parameters and mapping templates. |
|
GetGatewayResponsesRequest |
Container for the parameters to the GetGatewayResponses operation. Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types. |
|
GetGatewayResponsesResponse |
The collection of the GatewayResponse instances of a RestApi as a |
|
GetIntegrationRequest |
Container for the parameters to the GetIntegration operation. Get the integration settings. |
|
GetIntegrationResponse |
Represents an |
|
GetIntegrationResponseRequest |
Container for the parameters to the GetIntegrationResponse operation. Represents a get integration response. |
|
GetIntegrationResponseResponse |
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response. |
|
GetMethodRequest |
Container for the parameters to the GetMethod operation. Describe an existing Method resource. |
|
GetMethodResponse |
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. |
|
GetMethodResponseRequest |
Container for the parameters to the GetMethodResponse operation. Describes a MethodResponse resource. |
|
GetMethodResponseResponse |
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. |
|
GetModelRequest |
Container for the parameters to the GetModel operation. Describes an existing model defined for a RestApi resource. |
|
GetModelResponse |
Represents the data structure of a method's request or response payload. |
|
GetModelsRequest |
Container for the parameters to the GetModels operation. Describes existing Models defined for a RestApi resource. |
|
GetModelsResponse |
Represents a collection of Model resources. |
|
GetModelTemplateRequest |
Container for the parameters to the GetModelTemplate operation. Generates a sample mapping template that can be used to transform a payload into the structure of a model. |
|
GetModelTemplateResponse |
Represents a mapping template used to transform a payload. |
|
GetRequestValidatorRequest |
Container for the parameters to the GetRequestValidator operation. Gets a RequestValidator of a given RestApi. |
|
GetRequestValidatorResponse |
A set of validation rules for incoming Method requests. |
|
GetRequestValidatorsRequest |
Container for the parameters to the GetRequestValidators operation. Gets the RequestValidators collection of a given RestApi. |
|
GetRequestValidatorsResponse |
A collection of RequestValidator resources of a given RestApi. |
|
GetResourceRequest |
Container for the parameters to the GetResource operation. Lists information about a resource. |
|
GetResourceResponse |
Represents an API resource. |
|
GetResourcesRequest |
Container for the parameters to the GetResources operation. Lists information about a collection of Resource resources. |
|
GetResourcesResponse |
Represents a collection of Resource resources. |
|
GetRestApiRequest |
Container for the parameters to the GetRestApi operation. Lists the RestApi resource in the collection. |
|
GetRestApiResponse |
Represents a REST API. |
|
GetRestApisRequest |
Container for the parameters to the GetRestApis operation. Lists the RestApis resources for your collection. |
|
GetRestApisResponse |
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs. |
|
GetSdkRequest |
Container for the parameters to the GetSdk operation. Generates a client SDK for a RestApi and Stage. |
|
GetSdkResponse |
The binary blob response to GetSdk, which contains the generated SDK. |
|
GetSdkTypeRequest |
Container for the parameters to the GetSdkType operation. Gets an SDK type. |
|
GetSdkTypeResponse |
A type of SDK that API Gateway can generate. |
|
GetSdkTypesRequest |
Container for the parameters to the GetSdkTypes operation. Gets SDK types |
|
GetSdkTypesResponse |
The collection of SdkType instances. |
|
GetStageRequest |
Container for the parameters to the GetStage operation. Gets information about a Stage resource. |
|
GetStageResponse |
Represents a unique identifier for a version of a deployed RestApi that is callable by users. |
|
GetStagesRequest |
Container for the parameters to the GetStages operation. Gets information about one or more Stage resources. |
|
GetStagesResponse |
A list of Stage resources that are associated with the ApiKey resource. |
|
GetTagsRequest |
Container for the parameters to the GetTags operation. Gets the Tags collection for a given resource. |
|
GetTagsResponse |
The collection of tags. Each tag element is associated with a given resource. |
|
GetUsagePlanKeyRequest |
Container for the parameters to the GetUsagePlanKey operation. Gets a usage plan key of a given key identifier. |
|
GetUsagePlanKeyResponse |
Represents a usage plan key to identify a plan customer. |
|
GetUsagePlanKeysRequest |
Container for the parameters to the GetUsagePlanKeys operation. Gets 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. |
|
GetUsagePlanRequest |
Container for the parameters to the GetUsagePlan operation. Gets a usage plan of a given plan identifier. |
|
GetUsagePlanResponse |
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests. |
|
GetUsagePlansRequest |
Container for the parameters to the GetUsagePlans operation. Gets all the usage plans of the caller's account. |
|
GetUsagePlansResponse |
Represents a collection of usage plans for an AWS account. |
|
GetUsageRequest |
Container for the parameters to the GetUsage operation. Gets the usage data of a usage plan in a specified time interval. |
|
GetUsageResponse |
Represents the usage data of a usage plan. |
|
GetVpcLinkRequest |
Container for the parameters to the GetVpcLink operation. Gets a specified VPC link under the caller's account in a region. |
|
GetVpcLinkResponse |
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). |
|
GetVpcLinksRequest |
Container for the parameters to the GetVpcLinks operation. 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. |
|
ImportApiKeysRequest |
Container for the parameters to the ImportApiKeys operation. Import API keys from an external source, such as a CSV-formatted file. |
|
ImportApiKeysResponse |
The identifier of an ApiKey used in a UsagePlan. |
|
ImportDocumentationPartsRequest |
Container for the parameters to the ImportDocumentationParts operation. Imports documentation parts |
|
ImportDocumentationPartsResponse |
A collection of the imported DocumentationPart identifiers. |
|
ImportRestApiRequest |
Container for the parameters to the ImportRestApi operation. A feature of the API Gateway control service for creating a new API from an external API definition file. |
|
ImportRestApiResponse |
Represents a REST API. |
|
Integration |
Represents an |
|
IntegrationResponse |
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response. |
|
LimitExceededException |
The request exceeded the rate limit. Retry after the specified time period. |
|
Method |
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. |
|
MethodResponse |
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. |
|
MethodSetting |
Specifies the method setting properties. |
|
MethodSnapshot |
Represents a summary of a Method resource, given a particular date and time. |
|
Model |
Represents the data structure of a method's request or response payload. |
|
MutualTlsAuthentication |
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API. |
|
MutualTlsAuthenticationInput |
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API. |
|
NotFoundException |
The requested resource is not found. Make sure that the request URI is correct. |
|
PatchOperation |
For more information about supported patch operations, see Patch Operations. |
|
PutGatewayResponseRequest |
Container for the parameters to the PutGatewayResponse operation. Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. |
|
PutGatewayResponseResponse |
A gateway response of a given response type and status code, with optional response parameters and mapping templates. |
|
PutIntegrationRequest |
Container for the parameters to the PutIntegration operation. Sets up a method's integration. |
|
PutIntegrationResponse |
Represents an |
|
PutIntegrationResponseRequest |
Container for the parameters to the PutIntegrationResponse operation. Represents a put integration. |
|
PutIntegrationResponseResponse |
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response. |
|
PutMethodRequest |
Container for the parameters to the PutMethod operation. Add a method to an existing Resource resource. |
|
PutMethodResponse |
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. |
|
PutMethodResponseRequest |
Container for the parameters to the PutMethodResponse operation. Adds a MethodResponse to an existing Method resource. |
|
PutMethodResponseResponse |
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. |
|
PutRestApiRequest |
Container for the parameters to the PutRestApi operation. A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API. |
|
PutRestApiResponse |
Represents a REST API. |
|
QuotaSettings |
Quotas configured for a usage plan. |
|
RequestValidator |
A set of validation rules for incoming Method requests. |
|
Resource |
Represents an API resource. |
|
RestApi |
Represents a REST API. |
|
SdkConfigurationProperty |
A configuration property of an SDK type. |
|
SdkType |
A type of SDK that API Gateway can generate. |
|
ServiceUnavailableException |
The requested service is not available. For details see the accompanying error message. Retry after the specified time period. |
|
Stage |
Represents a unique identifier for a version of a deployed RestApi that is callable by users. |
|
StageKey |
A reference to a unique stage identified in the format |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Adds or updates a tag on a given resource. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TestInvokeAuthorizerRequest |
Container for the parameters to the TestInvokeAuthorizer operation. Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. |
|
TestInvokeAuthorizerResponse |
Represents the response of the test invoke request for a custom Authorizer |
|
TestInvokeMethodRequest |
Container for the parameters to the TestInvokeMethod operation. Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. |
|
TestInvokeMethodResponse |
Represents the response of the test invoke request in the HTTP method. |
|
ThrottleSettings |
The API request rate limits. |
|
TlsConfig |
Specifies the TLS configuration for an integration. |
|
TooManyRequestsException |
The request has reached its throttling limit. Retry after the specified time period. |
|
UnauthorizedException |
The request is denied because the caller has insufficient permissions. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes a tag from a given resource. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateAccountRequest |
Container for the parameters to the UpdateAccount operation. Changes information about the current Account resource. |
|
UpdateAccountResponse |
Represents an AWS account that is associated with API Gateway. |
|
UpdateApiKeyRequest |
Container for the parameters to the UpdateApiKey operation. Changes information about an ApiKey resource. |
|
UpdateApiKeyResponse |
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage. |
|
UpdateAuthorizerRequest |
Container for the parameters to the UpdateAuthorizer operation. Updates an existing Authorizer resource. |
|
UpdateAuthorizerResponse |
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method. |
|
UpdateBasePathMappingRequest |
Container for the parameters to the UpdateBasePathMapping operation. Changes information about the BasePathMapping resource. |
|
UpdateBasePathMappingResponse |
Represents the base path that callers of the API must provide as part of the URL after the domain name. |
|
UpdateClientCertificateRequest |
Container for the parameters to the UpdateClientCertificate operation. Changes information about an ClientCertificate resource. |
|
UpdateClientCertificateResponse |
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint. |
|
UpdateDeploymentRequest |
Container for the parameters to the UpdateDeployment operation. Changes information about a Deployment resource. |
|
UpdateDeploymentResponse |
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet. |
|
UpdateDocumentationPartRequest |
Container for the parameters to the UpdateDocumentationPart operation. Updates a documentation part. |
|
UpdateDocumentationPartResponse |
A documentation part for a targeted API entity. |
|
UpdateDocumentationVersionRequest |
Container for the parameters to the UpdateDocumentationVersion operation. Updates a documentation version. |
|
UpdateDocumentationVersionResponse |
A snapshot of the documentation of an API. |
|
UpdateDomainNameRequest |
Container for the parameters to the UpdateDomainName operation. Changes information about the DomainName resource. |
|
UpdateDomainNameResponse |
Represents a custom domain name as a user-friendly host name of an API (RestApi). |
|
UpdateGatewayResponseRequest |
Container for the parameters to the UpdateGatewayResponse operation. Updates a GatewayResponse of a specified response type on the given RestApi. |
|
UpdateGatewayResponseResponse |
A gateway response of a given response type and status code, with optional response parameters and mapping templates. |
|
UpdateIntegrationRequest |
Container for the parameters to the UpdateIntegration operation. Represents an update integration. |
|
UpdateIntegrationResponse |
Represents an |
|
UpdateIntegrationResponseRequest |
Container for the parameters to the UpdateIntegrationResponse operation. Represents an update integration response. |
|
UpdateIntegrationResponseResponse |
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response. |
|
UpdateMethodRequest |
Container for the parameters to the UpdateMethod operation. Updates an existing Method resource. |
|
UpdateMethodResponse |
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource. |
|
UpdateMethodResponseRequest |
Container for the parameters to the UpdateMethodResponse operation. Updates an existing MethodResponse resource. |
|
UpdateMethodResponseResponse |
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template. |
|
UpdateModelRequest |
Container for the parameters to the UpdateModel operation. Changes information about a model. The maximum size of the model is 400 KB. |
|
UpdateModelResponse |
Represents the data structure of a method's request or response payload. |
|
UpdateRequestValidatorRequest |
Container for the parameters to the UpdateRequestValidator operation. Updates a RequestValidator of a given RestApi. |
|
UpdateRequestValidatorResponse |
A set of validation rules for incoming Method requests. |
|
UpdateResourceRequest |
Container for the parameters to the UpdateResource operation. Changes information about a Resource resource. |
|
UpdateResourceResponse |
Represents an API resource. |
|
UpdateRestApiRequest |
Container for the parameters to the UpdateRestApi operation. Changes information about the specified API. |
|
UpdateRestApiResponse |
Represents a REST API. |
|
UpdateStageRequest |
Container for the parameters to the UpdateStage operation. Changes information about a Stage resource. |
|
UpdateStageResponse |
Represents a unique identifier for a version of a deployed RestApi that is callable by users. |
|
UpdateUsagePlanRequest |
Container for the parameters to the UpdateUsagePlan operation. Updates a usage plan of a given plan Id. |
|
UpdateUsagePlanResponse |
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests. |
|
UpdateUsageRequest |
Container for the parameters to the UpdateUsage operation. Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. |
|
UpdateUsageResponse |
Represents the usage data of a usage plan. |
|
UpdateVpcLinkRequest |
Container for the parameters to the UpdateVpcLink operation. Updates an existing VpcLink of a specified identifier. |
|
UpdateVpcLinkResponse |
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC). |
|
UsagePlan |
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests. |
|
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). |
Name | Description | |
---|---|---|
IAPIGatewayPaginatorFactory |
Paginators for the APIGateway service |
|
IGetApiKeysPaginator |
Paginator for the GetApiKeys operation |
|
IGetBasePathMappingsPaginator |
Paginator for the GetBasePathMappings operation |
|
IGetClientCertificatesPaginator |
Paginator for the GetClientCertificates operation |
|
IGetDeploymentsPaginator |
Paginator for the GetDeployments operation |
|
IGetDomainNamesPaginator |
Paginator for the GetDomainNames operation |
|
IGetModelsPaginator |
Paginator for the GetModels operation |
|
IGetResourcesPaginator |
Paginator for the GetResources operation |
|
IGetRestApisPaginator |
Paginator for the GetRestApis operation |
|
IGetUsagePaginator |
Paginator for the GetUsage operation |
|
IGetUsagePlanKeysPaginator |
Paginator for the GetUsagePlanKeys operation |
|
IGetUsagePlansPaginator |
Paginator for the GetUsagePlans operation |
|
IGetVpcLinksPaginator |
Paginator for the GetVpcLinks operation |