apigateway-2015-07-09
library
Classes
-
AccessLogSettings
-
Access log settings, including the access log format and access log
destination ARN.
-
Account
-
Represents an AWS account that is associated with API Gateway.
-
APIGateway
-
Amazon API Gateway helps developers deliver robust, secure, and scalable
mobile and web application back ends. API Gateway allows developers to
securely connect mobile and web applications to APIs that run on AWS Lambda,
Amazon EC2, or other publicly addressable web services that are hosted
outside of AWS.
-
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.
-
ApiKeyIds
-
The identifier of an ApiKey used in a UsagePlan.
-
ApiKeys
-
Represents a collection of API keys as represented by an ApiKeys
resource.
-
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.
-
Authorizers
-
Represents a collection of Authorizer resources.
-
AwsClientCredentials
-
AWS credentials.
-
BasePathMapping
-
Represents the base path that callers of the API must provide as part of the
URL after the domain name.
-
BasePathMappings
-
Represents a collection of BasePathMapping resources.
-
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.
-
ClientCertificates
-
Represents a collection of ClientCertificate resources.
-
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.
-
Deployments
-
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.
-
DocumentationPart
-
A documentation part for a targeted API entity.
-
DocumentationPartIds
-
A collection of the imported DocumentationPart identifiers.
-
DocumentationPartLocation
-
Specifies the target API entity to which the documentation applies.
-
DocumentationParts
-
The collection of documentation parts of an API.
-
DocumentationVersion
-
A snapshot of the documentation of an API.
-
DocumentationVersions
-
The collection of documentation snapshots of an API.
-
DomainName
-
Represents a custom domain name as a user-friendly host name of an API
(RestApi).
-
DomainNames
-
Represents a collection of DomainName resources.
-
EndpointConfiguration
-
The endpoint configuration to indicate the types of endpoints an API
(RestApi) or its custom domain name (DomainName) has.
-
ExportResponse
-
The binary blob response to GetExport, which contains the generated
SDK.
-
GatewayResponse
-
A gateway response of a given response type and status code, with optional
response parameters and mapping templates.
-
GatewayResponses
-
The collection of the GatewayResponse instances of a RestApi
as a
responseType-to-GatewayResponse object map of
key-value pairs. As such, pagination is not supported for querying this
collection.
-
Integration
-
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
-
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.
-
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.
-
Models
-
Represents a collection of Model resources.
-
MutualTlsAuthentication
-
If specified, API Gateway performs two-way authentication between the client
and the server. Clients must present a trusted certificate to access your
custom domain name.
-
MutualTlsAuthenticationInput
-
If specified, API Gateway performs two-way authentication between the client
and the server. Clients must present a trusted certificate to access your
custom domain name.
-
PatchOperation
-
A single patch operation to apply to the specified resource. Please refer to
http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each
operation is used.
-
QuotaSettings
-
Quotas configured for a usage plan.
-
RequestValidator
-
A set of validation rules for incoming Method requests.
-
RequestValidators
-
A collection of RequestValidator resources of a given RestApi.
-
Resource
-
Represents an API resource.
-
Resources
-
Represents a collection of Resource resources.
-
RestApi
-
Represents a REST API.
-
RestApis
-
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.
-
SdkConfigurationProperty
-
A configuration property of an SDK type.
-
SdkResponse
-
The binary blob response to GetSdk, which contains the generated SDK.
-
SdkType
-
A type of SDK that API Gateway can generate.
-
SdkTypes
-
The collection of SdkType instances.
-
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}.
-
Stages
-
A list of Stage resources that are associated with the ApiKey
resource.
-
Tags
-
The collection of tags. Each tag element is associated with a given
resource.
-
Template
-
Represents a mapping template used to transform a payload.
-
TestInvokeAuthorizerResponse
-
Represents the response of the test invoke request for a custom
Authorizer
-
TestInvokeMethodResponse
-
Represents the response of the test invoke request in the HTTP method.
-
ThrottleSettings
-
The API request rate limits.
-
TlsConfig
-
-
Usage
-
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.
-
UsagePlanKeys
-
Represents the collection of usage plan keys added to usage plans for the
associated API keys and, possibly, other types of keys.
-
UsagePlans
-
Represents a collection of usage plans for an AWS account.
-
VpcLink
-
An API Gateway VPC link for a RestApi to access resources in an
Amazon Virtual Private Cloud (VPC).
-
VpcLinks
-
The collection of VPC links under the caller's account in a region.
