| Class | Description |
|---|---|
| ApiKey |
A resource that can be distributed to callers for executing Method resources that require an API key.
|
| ApiStage |
API stage name of the associated API stage in a usage plan.
|
| Authorizer |
Represents an authorization layer for methods.
|
| 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.
|
| CreateApiKeyRequest |
Request to create an ApiKey resource.
|
| 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.
|
| CreateAuthorizerResponse |
Represents an authorization layer for methods.
|
| CreateBasePathMappingRequest |
Requests Amazon API Gateway to create 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 |
Requests Amazon API Gateway to create a Deployment resource.
|
| CreateDeploymentResponse | |
| CreateDocumentationPartRequest |
Creates a new documentation part of a given API.
|
| CreateDocumentationPartResponse |
A documentation part for a targeted API entity.
|
| CreateDocumentationVersionRequest |
Creates a new documentation version of a given API.
|
| CreateDocumentationVersionResponse |
A snapshot of the documentation of an API.
|
| CreateDomainNameRequest |
A request to create a new domain name.
|
| CreateDomainNameResponse |
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
| CreateModelRequest | |
| CreateModelResponse |
Represents the data structure of a method's request or response payload.
|
| CreateRequestValidatorRequest |
Creates a RequestValidator of a given RestApi.
|
| CreateRequestValidatorResponse |
A set of validation rules for incoming Method requests.
|
| CreateResourceRequest |
Requests Amazon API Gateway to create a Resource resource.
|
| CreateResourceResponse |
Represents an API resource.
|
| CreateRestApiRequest |
The POST Request to add a new RestApi resource to your collection.
|
| CreateRestApiResponse |
Represents a REST API.
|
| CreateStageRequest |
Requests Amazon API Gateway to create a Stage resource.
|
| 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.
|
| 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.
|
| CreateUsagePlanResponse |
Represents a usage plan than can specify who can assess associated API stages with specified request limits and
quotas.
|
| DeleteApiKeyRequest |
A request to delete the ApiKey resource.
|
| DeleteApiKeyResponse | |
| DeleteAuthorizerRequest |
Request to delete an existing Authorizer resource.
|
| DeleteAuthorizerResponse | |
| DeleteBasePathMappingRequest |
A request to delete the BasePathMapping resource.
|
| DeleteBasePathMappingResponse | |
| DeleteClientCertificateRequest |
A request to delete the ClientCertificate resource.
|
| DeleteClientCertificateResponse | |
| DeleteDeploymentRequest |
Requests Amazon API Gateway to delete a Deployment resource.
|
| DeleteDeploymentResponse | |
| DeleteDocumentationPartRequest |
Deletes an existing documentation part of an API.
|
| DeleteDocumentationPartResponse | |
| DeleteDocumentationVersionRequest |
Deletes an existing documentation version of an API.
|
| DeleteDocumentationVersionResponse | |
| DeleteDomainNameRequest |
A request to delete the DomainName resource.
|
| DeleteDomainNameResponse | |
| DeleteIntegrationRequest |
Represents a delete integration request.
|
| DeleteIntegrationResponse | |
| DeleteIntegrationResponseRequest |
Represents a delete integration response request.
|
| DeleteIntegrationResponseResponse | |
| DeleteMethodRequest |
Request to delete an existing Method resource.
|
| DeleteMethodResponse | |
| DeleteMethodResponseRequest |
A request to delete an existing MethodResponse resource.
|
| DeleteMethodResponseResponse | |
| DeleteModelRequest |
Request to delete an existing model in an existing RestApi resource.
|
| DeleteModelResponse | |
| DeleteRequestValidatorRequest |
Deletes a specified RequestValidator of a given RestApi.
|
| DeleteRequestValidatorResponse | |
| DeleteResourceRequest |
Request to delete a Resource.
|
| DeleteResourceResponse | |
| DeleteRestApiRequest |
Request to delete the specified API from your collection.
|
| DeleteRestApiResponse | |
| DeleteStageRequest |
Requests Amazon API Gateway to delete a Stage resource.
|
| DeleteStageResponse | |
| DeleteUsagePlanKeyRequest |
The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
|
| DeleteUsagePlanKeyResponse | |
| DeleteUsagePlanRequest |
The DELETE request to delete a uasge plan of a given plan Id.
|
| DeleteUsagePlanResponse | |
| 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 domain name that is contained in a simpler, more intuitive URL that can be called.
|
| FlushStageAuthorizersCacheRequest |
Request to flush authorizer cache entries on a specified stage.
|
| FlushStageAuthorizersCacheResponse | |
| FlushStageCacheRequest |
Requests Amazon API Gateway to flush a stage's cache.
|
| FlushStageCacheResponse | |
| GenerateClientCertificateRequest |
A request to generate a ClientCertificate resource.
|
| GenerateClientCertificateResponse |
Represents a client certificate used to configure client-side SSL authentication while sending requests to the
integration endpoint.
|
| GetAccountRequest |
Requests Amazon API Gateway to get information about the current Account resource.
|
| GetAccountResponse |
Represents an AWS account that is associated with Amazon API Gateway.
|
| GetApiKeyRequest |
A request to get information about the current ApiKey resource.
|
| 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.
|
| GetApiKeysResponse |
Represents a collection of API keys as represented by an ApiKeys resource.
|
| GetAuthorizerRequest |
Request to describe an existing Authorizer resource.
|
| GetAuthorizerResponse |
Represents an authorization layer for methods.
|
| GetAuthorizersRequest |
Request to describe an existing Authorizers resource.
|
| GetAuthorizersResponse |
Represents a collection of Authorizer resources.
|
| GetBasePathMappingRequest |
Request to 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 |
A request to get information about a collection of BasePathMapping resources.
|
| GetBasePathMappingsResponse |
Represents a collection of BasePathMapping resources.
|
| GetClientCertificateRequest |
A request to get 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 |
A request to get information about a collection of ClientCertificate resources.
|
| GetClientCertificatesResponse |
Represents a collection of ClientCertificate resources.
|
| GetDeploymentRequest |
Requests Amazon API Gateway to get information about a Deployment resource.
|
| GetDeploymentResponse | |
| GetDeploymentsRequest |
Requests Amazon 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.
|
| GetDocumentationPartRequest |
Gets a specified documentation part of a given API.
|
| GetDocumentationPartResponse |
A documentation part for a targeted API entity.
|
| GetDocumentationPartsRequest |
Gets the documentation parts of an API.
|
| GetDocumentationPartsResponse |
The collection of documentation parts of an API.
|
| GetDocumentationVersionRequest |
Gets a documentation snapshot of an API.
|
| GetDocumentationVersionResponse |
A snapshot of the documentation of an API.
|
| GetDocumentationVersionsRequest |
Gets the documentation versions of an API.
|
| GetDocumentationVersionsResponse |
The collection of documentation snapshots of an API.
|
| GetDomainNameRequest |
Request to get the name of a DomainName resource.
|
| GetDomainNameResponse |
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
| GetDomainNamesRequest |
Request to describe a collection of DomainName resources.
|
| GetDomainNamesResponse |
Represents a collection of DomainName resources.
|
| GetExportRequest | |
| GetExportResponse |
The binary blob response to GetExport, which contains the generated SDK.
|
| GetIntegrationRequest |
Represents a get integration request.
|
| GetIntegrationResponse |
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
|
| GetIntegrationResponseRequest |
Represents a get integration response request.
|
| GetIntegrationResponseResponse |
Represents an integration response.
|
| GetMethodRequest |
Request to describe an existing Method resource.
|
| 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.
|
| 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.
|
| GetModelResponse |
Represents the data structure of a method's request or response payload.
|
| GetModelsRequest | |
| GetModelsResponse |
Represents a collection of Model resources.
|
| GetModelTemplateRequest |
Request to generate a sample mapping template used to transform the payload.
|
| GetModelTemplateResponse |
Represents a mapping template used to transform a payload.
|
| GetRequestValidatorRequest |
Gets a RequestValidator of a given RestApi.
|
| GetRequestValidatorResponse |
A set of validation rules for incoming Method requests.
|
| GetRequestValidatorsRequest |
Gets the RequestValidators collection of a given RestApi.
|
| GetRequestValidatorsResponse |
A collection of RequestValidator resources of a given RestApi.
|
| GetResourceRequest |
Request to list information about a resource.
|
| GetResourceResponse |
Represents an API resource.
|
| GetResourcesRequest |
Request to list information about a collection of resources.
|
| GetResourcesResponse |
Represents a collection of Resource resources.
|
| GetRestApiRequest |
The GET request to list an existing RestApi defined for your collection.
|
| GetRestApiResponse |
Represents a REST API.
|
| 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.
|
| GetSdkRequest | |
| GetSdkResponse |
The binary blob response to GetSdk, which contains the generated SDK.
|
| GetSdkTypeRequest |
Get an SdkType instance.
|
| GetSdkTypeResponse |
A type of SDK that API Gateway can generate.
|
| GetSdkTypesRequest |
Get the SdkTypes collection.
|
| GetSdkTypesResponse |
The collection of SdkType instances.
|
| GetStageRequest |
Requests Amazon API Gateway to get information about a Stage resource.
|
| GetStageResponse |
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
|
| GetStagesRequest |
Requests Amazon API Gateway to get information about one or more Stage resources.
|
| GetStagesResponse | |
| GetUsagePlanKeyRequest |
The GET request to get a usage plan key of a given key identifier.
|
| 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.
|
| 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.
|
| GetUsagePlanResponse |
Represents a usage plan than can specify who can assess associated API stages with specified request limits and
quotas.
|
| 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.
|
| ImportApiKeysRequest |
The POST request to import API keys from an external source, such as a CSV-formatted file.
|
| ImportApiKeysResponse | |
| ImportDocumentationPartsRequest |
Import documentation parts from an external (e.g., Swagger) definition file.
|
| ImportDocumentationPartsResponse |
A collection of the imported DocumentationPart identifiers.
|
| ImportRestApiRequest |
A POST request to import an API to Amazon API Gateway using an input of an API definition file.
|
| ImportRestApiResponse |
Represents a REST API.
|
| Integration |
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
|
| IntegrationResponse |
Represents an integration response.
|
| Method |
Represents a client-facing interface by which the client calls the API to access back-end resources.
|
| MethodResponse |
Represents a method response of a given HTTP status code returned to the client.
|
| 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.
|
| PatchOperation |
A single patch operation to apply to the specified resource.
|
| PutIntegrationRequest |
Represents a put integration request.
|
| PutIntegrationResponse |
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
|
| PutIntegrationResponseRequest |
Represents a put integration response request.
|
| PutIntegrationResponseResponse |
Represents an integration response.
|
| PutMethodRequest |
Request to 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.
|
| PutMethodResponseRequest |
Request to add a MethodResponse to an existing Method resource.
|
| 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.
|
| 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.
|
| 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
{restApiId}/{stage}. |
| TestInvokeAuthorizerRequest |
Make a request to simulate the execution of an Authorizer.
|
| TestInvokeAuthorizerResponse |
Represents the response of the test invoke request for a custom Authorizer
|
| TestInvokeMethodRequest |
Make a request to simulate the execution of a Method.
|
| TestInvokeMethodResponse |
Represents the response of the test invoke request in the HTTP method.
|
| ThrottleSettings |
The API request rate limits.
|
| UpdateAccountRequest |
Requests Amazon API Gateway to change information about the current Account resource.
|
| UpdateAccountResponse |
Represents an AWS account that is associated with Amazon API Gateway.
|
| UpdateApiKeyRequest |
A request to change information about an ApiKey resource.
|
| 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.
|
| UpdateAuthorizerResponse |
Represents an authorization layer for methods.
|
| UpdateBasePathMappingRequest |
A request to change 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 |
A request to change 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 |
Requests Amazon API Gateway to change information about a Deployment resource.
|
| UpdateDeploymentResponse | |
| UpdateDocumentationPartRequest |
Updates an existing documentation part of a given API.
|
| UpdateDocumentationPartResponse |
A documentation part for a targeted API entity.
|
| UpdateDocumentationVersionRequest |
Updates an existing documentation version of an API.
|
| UpdateDocumentationVersionResponse |
A snapshot of the documentation of an API.
|
| UpdateDomainNameRequest |
A request to change information about the DomainName resource.
|
| UpdateDomainNameResponse |
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
|
| UpdateIntegrationRequest |
Represents an update integration request.
|
| UpdateIntegrationResponse |
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
|
| UpdateIntegrationResponseRequest |
Represents an update integration response request.
|
| UpdateIntegrationResponseResponse |
Represents an integration response.
|
| UpdateMethodRequest |
Request to update an existing Method resource.
|
| 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.
|
| 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.
|
| UpdateModelResponse |
Represents the data structure of a method's request or response payload.
|
| UpdateRequestValidatorRequest |
Updates a RequestValidator of a given RestApi.
|
| UpdateRequestValidatorResponse |
A set of validation rules for incoming Method requests.
|
| UpdateResourceRequest |
Request to change information about a Resource resource.
|
| UpdateResourceResponse |
Represents an API resource.
|
| UpdateRestApiRequest |
Request to update an existing RestApi resource in your collection.
|
| UpdateRestApiResponse |
Represents a REST API.
|
| UpdateStageRequest |
Requests Amazon API Gateway to change information about a Stage resource.
|
| 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.
|
| UpdateUsagePlanResponse |
Represents a usage plan than can specify who can assess associated API stages with specified request limits and
quotas.
|
| UpdateUsageRequest |
The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified
API key.
|
| UpdateUsageResponse |
Represents the usage data of a usage plan.
|
| UsagePlan |
Represents a usage plan than can specify who can assess associated API stages with specified request limits and
quotas.
|
| UsagePlanKey |
Represents a usage plan key to identify a plan customer.
|
| Enum | Description |
|---|---|
| ApiKeysFormat | |
| AuthorizerType |
The authorizer type.
|
| CacheClusterStatus |
Returns the status of the CacheCluster.
|
| ContentHandlingStrategy | |
| DocumentationPartType | |
| IntegrationType |
The integration type.
|
| Op | |
| PutMode | |
| QuotaPeriodType | |
| UnauthorizedCacheControlHeaderStrategy |
| Exception | Description |
|---|---|
| APIGatewayException |
Base exception for all service exceptions thrown by Amazon API Gateway
|
| BadRequestException | |
| ConflictException | |
| LimitExceededException | |
| NotFoundException | |
| ServiceUnavailableException | |
| TooManyRequestsException | |
| UnauthorizedException |
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.