DataFire integration for Amazon API Gateway
npm install @datafire/amazonaws_apigatewayClient library for Amazon API Gateway
bash
npm install --save @datafire/amazonaws_apigateway
`
js
let amazonaws_apigateway = require('@datafire/amazonaws_apigateway').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});amazonaws_apigateway.GetAccount({}).then(data => {
console.log(data);
});
`Description
Amazon API Gateway
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.
Actions
$3
js
amazonaws_apigateway.GetAccount({}, context)
`#### Input
* input
#### Output
* output Account
$3
js
amazonaws_apigateway.UpdateAccount({}, context)
`#### Input
* input
* patchOperations ListOfPatchOperation#### Output
* output Account
$3
js
amazonaws_apigateway.GetApiKeys({}, context)
`#### Input
* input
* limit
* position #### Output
* output ApiKeys
$3
js
amazonaws_apigateway.CreateApiKey({}, context)
`#### Input
* input
* customerId String
* description String
* enabled Boolean
* generateDistinctId Boolean
* name String
* stageKeys ListOfStageKeys
* value String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteApiKey({}, context)
`#### Input
* input
* apiKey #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetApiKey({}, context)
`#### Input
* input
* apiKey #### Output
* output ApiKey
$3
js
amazonaws_apigateway.UpdateApiKey({}, context)
`#### Input
* input
* apiKey
* patchOperations ListOfPatchOperation#### Output
* output ApiKey
$3
js
amazonaws_apigateway.ImportApiKeys({
"body": ""
}, context)
`#### Input
* input
* body required Blob#### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetClientCertificates({}, context)
`#### Input
* input
* limit
* position #### Output
* output ClientCertificates
$3
js
amazonaws_apigateway.GenerateClientCertificate({}, context)
`#### Input
* input
* description String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteClientCertificate({}, context)
`#### Input
* input
* clientcertificateId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetClientCertificate({}, context)
`#### Input
* input
* clientcertificateId #### Output
* output ClientCertificate
$3
js
amazonaws_apigateway.UpdateClientCertificate({}, context)
`#### Input
* input
* clientcertificateId
* patchOperations ListOfPatchOperation#### Output
* output ClientCertificate
$3
js
amazonaws_apigateway.GetDomainNames({}, context)
`#### Input
* input
* limit
* position #### Output
* output DomainNames
$3
js
amazonaws_apigateway.CreateDomainName({
"domainName": ""
}, context)
`#### Input
* input
* certificateArn String
* certificateBody String
* certificateChain String
* certificateName String
* certificatePrivateKey String
* domainName required String
* endpointConfiguration EndpointConfiguration
* regionalCertificateArn String
* regionalCertificateName String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteDomainName({}, context)
`#### Input
* input
* domainName #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetDomainName({}, context)
`#### Input
* input
* domainName #### Output
* output DomainName
$3
js
amazonaws_apigateway.UpdateDomainName({}, context)
`#### Input
* input
* domainName
* patchOperations ListOfPatchOperation#### Output
* output DomainName
$3
js
amazonaws_apigateway.GetBasePathMappings({}, context)
`#### Input
* input
* limit
* position
* domainName #### Output
* output BasePathMappings
$3
js
amazonaws_apigateway.CreateBasePathMapping({
"restApiId": ""
}, context)
`#### Input
* input
* domainName
* basePath String
* restApiId required String
* stage String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteBasePathMapping({}, context)
`#### Input
* input
* domainName
* basePath #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetBasePathMapping({}, context)
`#### Input
* input
* domainName
* basePath #### Output
* output BasePathMapping
$3
js
amazonaws_apigateway.UpdateBasePathMapping({}, context)
`#### Input
* input
* domainName
* basePath
* patchOperations ListOfPatchOperation#### Output
* output BasePathMapping
$3
js
amazonaws_apigateway.GetRestApis({}, context)
`#### Input
* input
* limit
* position #### Output
* output RestApis
$3
js
amazonaws_apigateway.CreateRestApi({
"name": ""
}, context)
`#### Input
* input
* apiKeySource ApiKeySourceType
* binaryMediaTypes ListOfString
* cloneFrom String
* description String
* endpointConfiguration EndpointConfiguration
* minimumCompressionSize NullableInteger
* name required String
* version String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteRestApi({}, context)
`#### Input
* input
* restapiId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetRestApi({}, context)
`#### Input
* input
* restapiId #### Output
* output RestApi
$3
js
amazonaws_apigateway.UpdateRestApi({}, context)
`#### Input
* input
* restapiId
* patchOperations ListOfPatchOperation#### Output
* output RestApi
$3
js
amazonaws_apigateway.PutRestApi({
"body": ""
}, context)
`#### Input
* input
* restapiId
* body required Blob#### Output
* output RestApi
$3
js
amazonaws_apigateway.GetAuthorizers({}, context)
`#### Input
* input
* restapiId #### Output
* output Authorizers
$3
js
amazonaws_apigateway.CreateAuthorizer({
"name": "",
"type": ""
}, context)
`#### Input
* input
* restapiId
* authType String
* authorizerCredentials String
* authorizerResultTtlInSeconds NullableInteger
* authorizerUri String
* identitySource String
* identityValidationExpression String
* name required String
* providerARNs ListOfARNs
* type required AuthorizerType#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteAuthorizer({}, context)
`#### Input
* input
* restapiId
* authorizerId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetAuthorizer({}, context)
`#### Input
* input
* restapiId
* authorizerId #### Output
* output Authorizer
$3
js
amazonaws_apigateway.UpdateAuthorizer({}, context)
`#### Input
* input
* restapiId
* authorizerId
* patchOperations ListOfPatchOperation#### Output
* output Authorizer
$3
js
amazonaws_apigateway.TestInvokeAuthorizer({}, context)
`#### Input
* input
* restapiId
* authorizerId
* additionalContext MapOfStringToString
* body String
* headers MapOfHeaderValues
* pathWithQueryString String
* stageVariables MapOfStringToString#### Output
* output TestInvokeAuthorizerResponse
$3
js
amazonaws_apigateway.GetDeployments({}, context)
`#### Input
* input
* limit
* position
* restapiId #### Output
* output Deployments
$3
js
amazonaws_apigateway.CreateDeployment({}, context)
`#### Input
* input
* restapiId
* cacheClusterEnabled NullableBoolean
* cacheClusterSize CacheClusterSize
* canarySettings DeploymentCanarySettings
* description String
* stageDescription String
* stageName String
* variables MapOfStringToString#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteDeployment({}, context)
`#### Input
* input
* restapiId
* deploymentId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetDeployment({}, context)
`#### Input
* input
* restapiId
* deploymentId #### Output
* output Deployment
$3
js
amazonaws_apigateway.UpdateDeployment({}, context)
`#### Input
* input
* restapiId
* deploymentId
* patchOperations ListOfPatchOperation#### Output
* output Deployment
$3
js
amazonaws_apigateway.GetDocumentationParts({}, context)
`#### Input
* input
* restapiId #### Output
* output DocumentationParts
$3
js
amazonaws_apigateway.CreateDocumentationPart({
"location": {
"type": ""
},
"properties": ""
}, context)
`#### Input
* input
* restapiId
* location required DocumentationPartLocation
* properties required String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.ImportDocumentationParts({
"body": ""
}, context)
`#### Input
* input
* restapiId
* body required Blob#### Output
* output DocumentationPartIds
$3
js
amazonaws_apigateway.DeleteDocumentationPart({}, context)
`#### Input
* input
* restapiId
* partId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetDocumentationPart({}, context)
`#### Input
* input
* restapiId
* partId #### Output
* output DocumentationPart
$3
js
amazonaws_apigateway.UpdateDocumentationPart({}, context)
`#### Input
* input
* restapiId
* partId
* patchOperations ListOfPatchOperation#### Output
* output DocumentationPart
$3
js
amazonaws_apigateway.GetDocumentationVersions({}, context)
`#### Input
* input
* restapiId #### Output
* output DocumentationVersions
$3
js
amazonaws_apigateway.CreateDocumentationVersion({
"documentationVersion": ""
}, context)
`#### Input
* input
* restapiId
* description String
* documentationVersion required String
* stageName String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteDocumentationVersion({}, context)
`#### Input
* input
* restapiId
* docVersion #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetDocumentationVersion({}, context)
`#### Input
* input
* restapiId
* docVersion #### Output
* output DocumentationVersion
$3
js
amazonaws_apigateway.UpdateDocumentationVersion({}, context)
`#### Input
* input
* restapiId
* docVersion
* patchOperations ListOfPatchOperation#### Output
* output DocumentationVersion
$3
js
amazonaws_apigateway.GetGatewayResponses({}, context)
`#### Input
* input
* restapiId #### Output
* output GatewayResponses
$3
js
amazonaws_apigateway.DeleteGatewayResponse({}, context)
`#### Input
* input
* restapiId
* responseType #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetGatewayResponse({}, context)
`#### Input
* input
* restapiId
* responseType #### Output
* output GatewayResponse
$3
js
amazonaws_apigateway.UpdateGatewayResponse({}, context)
`#### Input
* input
* restapiId
* responseType
* patchOperations ListOfPatchOperation#### Output
* output GatewayResponse
$3
js
amazonaws_apigateway.PutGatewayResponse({}, context)
`#### Input
* input
* restapiId
* responseType
* responseParameters MapOfStringToString
* responseTemplates MapOfStringToString
* statusCode StatusCode#### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetModels({}, context)
`#### Input
* input
* limit
* position
* restapiId #### Output
* output Models
$3
js
amazonaws_apigateway.CreateModel({
"name": "",
"contentType": ""
}, context)
`#### Input
* input
* restapiId
* contentType required String
* description String
* name required String
* schema String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteModel({}, context)
`#### Input
* input
* restapiId
* modelName #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetModel({}, context)
`#### Input
* input
* restapiId
* modelName #### Output
* output Model
$3
js
amazonaws_apigateway.UpdateModel({}, context)
`#### Input
* input
* restapiId
* modelName
* patchOperations ListOfPatchOperation#### Output
* output Model
$3
js
amazonaws_apigateway.GetModelTemplate({}, context)
`#### Input
* input
* restapiId
* modelName #### Output
* output Template
$3
js
amazonaws_apigateway.GetRequestValidators({}, context)
`#### Input
* input
* restapiId #### Output
* output RequestValidators
$3
js
amazonaws_apigateway.CreateRequestValidator({}, context)
`#### Input
* input
* restapiId
* name String
* validateRequestBody Boolean
* validateRequestParameters Boolean#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteRequestValidator({}, context)
`#### Input
* input
* restapiId
* requestvalidatorId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetRequestValidator({}, context)
`#### Input
* input
* restapiId
* requestvalidatorId #### Output
* output RequestValidator
$3
js
amazonaws_apigateway.UpdateRequestValidator({}, context)
`#### Input
* input
* restapiId
* requestvalidatorId
* patchOperations ListOfPatchOperation#### Output
* output RequestValidator
$3
js
amazonaws_apigateway.GetResources({}, context)
`#### Input
* input
* limit
* position
* restapiId #### Output
* output Resources
$3
js
amazonaws_apigateway.CreateResource({
"pathPart": ""
}, context)
`#### Input
* input
* restapiId
* parentId
* pathPart required String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteResource({}, context)
`#### Input
* input
* restapiId
* resourceId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetResource({}, context)
`#### Input
* input
* restapiId
* resourceId #### Output
* output Resource
$3
js
amazonaws_apigateway.UpdateResource({}, context)
`#### Input
* input
* restapiId
* resourceId
* patchOperations ListOfPatchOperation#### Output
* output Resource
$3
js
amazonaws_apigateway.DeleteMethod({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetMethod({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod #### Output
* output Method
$3
js
amazonaws_apigateway.UpdateMethod({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* patchOperations ListOfPatchOperation#### Output
* output Method
$3
js
amazonaws_apigateway.TestInvokeMethod({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* body String
* clientCertificateId String
* headers MapOfHeaderValues
* pathWithQueryString String
* stageVariables MapOfStringToString#### Output
* output TestInvokeMethodResponse
$3
js
amazonaws_apigateway.PutMethod({
"authorizationType": ""
}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* apiKeyRequired Boolean
* authorizationScopes ListOfString
* authorizationType required String
* authorizerId String
* operationName String
* requestModels MapOfStringToString
* requestParameters MapOfStringToBoolean
* requestValidatorId String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteIntegration({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetIntegration({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod #### Output
* output Integration
$3
js
amazonaws_apigateway.UpdateIntegration({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* patchOperations ListOfPatchOperation#### Output
* output Integration
$3
js
amazonaws_apigateway.PutIntegration({
"type": ""
}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* cacheKeyParameters ListOfString
* cacheNamespace String
* connectionId String
* connectionType ConnectionType
* contentHandling ContentHandlingStrategy
* credentials String
* integrationHttpMethod String
* passthroughBehavior String
* requestParameters MapOfStringToString
* requestTemplates MapOfStringToString
* timeoutInMillis NullableInteger
* type required IntegrationType
* uri String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteIntegrationResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetIntegrationResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode #### Output
* output IntegrationResponse
$3
js
amazonaws_apigateway.UpdateIntegrationResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode
* patchOperations ListOfPatchOperation#### Output
* output IntegrationResponse
$3
js
amazonaws_apigateway.PutIntegrationResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode
* contentHandling ContentHandlingStrategy
* responseParameters MapOfStringToString
* responseTemplates MapOfStringToString
* selectionPattern String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteMethodResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetMethodResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode #### Output
* output MethodResponse
$3
js
amazonaws_apigateway.UpdateMethodResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode
* patchOperations ListOfPatchOperation#### Output
Output schema unknown
$3
js
amazonaws_apigateway.PutMethodResponse({}, context)
`#### Input
* input
* restapiId
* resourceId
* httpMethod
* statusCode
* responseModels MapOfStringToString
* responseParameters MapOfStringToBoolean#### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetStages({}, context)
`#### Input
* input
* restapiId #### Output
* output Stages
$3
js
amazonaws_apigateway.CreateStage({
"stageName": "",
"deploymentId": ""
}, context)
`#### Input
* input
* restapiId
* cacheClusterEnabled Boolean
* cacheClusterSize CacheClusterSize
* canarySettings CanarySettings
* deploymentId required String
* description String
* documentationVersion String
* stageName required String
* tags MapOfStringToString
* variables MapOfStringToString#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteStage({}, context)
`#### Input
* input
* restapiId
* stageName #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetStage({}, context)
`#### Input
* input
* restapiId
* stageName #### Output
* output Stage
$3
js
amazonaws_apigateway.UpdateStage({}, context)
`#### Input
* input
* restapiId
* stageName
* patchOperations ListOfPatchOperation#### Output
* output Stage
$3
js
amazonaws_apigateway.FlushStageAuthorizersCache({}, context)
`#### Input
* input
* restapiId
* stageName #### Output
Output schema unknown
$3
js
amazonaws_apigateway.FlushStageCache({}, context)
`#### Input
* input
* restapiId
* stageName #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetExport({}, context)
`#### Input
* input
* restapiId
* stageName
* exportType #### Output
* output ExportResponse
$3
js
amazonaws_apigateway.GetSdk({}, context)
`#### Input
* input
* restapiId
* stageName
* sdkType #### Output
* output SdkResponse
$3
js
amazonaws_apigateway.ImportRestApi({
"body": ""
}, context)
`#### Input
* input
* body required Blob#### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetSdkTypes({}, context)
`#### Input
* input
#### Output
* output SdkTypes
$3
js
amazonaws_apigateway.GetSdkType({}, context)
`#### Input
* input
* sdktypeId #### Output
* output SdkType
$3
js
amazonaws_apigateway.UntagResource({}, context)
`#### Input
* input
* resourceArn #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetTags({}, context)
`#### Input
* input
* resourceArn #### Output
* output Tags
$3
js
amazonaws_apigateway.TagResource({
"tags": []
}, context)
`#### Input
* input
* resourceArn
* tags required MapOfStringToString#### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetUsagePlans({}, context)
`#### Input
* input
* limit
* position #### Output
* output UsagePlans
$3
js
amazonaws_apigateway.CreateUsagePlan({
"name": ""
}, context)
`#### Input
* input
* apiStages ListOfApiStage
* description String
* name required String
* quota QuotaSettings
* throttle ThrottleSettings#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteUsagePlan({
"usageplanId": ""
}, context)
`#### Input
* input
* usageplanId required #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetUsagePlan({
"usageplanId": ""
}, context)
`#### Input
* input
* usageplanId required #### Output
* output UsagePlan
$3
js
amazonaws_apigateway.UpdateUsagePlan({
"usageplanId": ""
}, context)
`#### Input
* input
* usageplanId required
* patchOperations ListOfPatchOperation#### Output
* output UsagePlan
$3
js
amazonaws_apigateway.GetUsagePlanKeys({
"usageplanId": ""
}, context)
`#### Input
* input
* limit
* position
* usageplanId required #### Output
* output UsagePlanKeys
$3
js
amazonaws_apigateway.CreateUsagePlanKey({
"usageplanId": "",
"keyId": "",
"keyType": ""
}, context)
`#### Input
* input
* usageplanId required
* keyId required String
* keyType required String#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteUsagePlanKey({
"usageplanId": "",
"keyId": ""
}, context)
`#### Input
* input
* usageplanId required
* keyId required #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetUsagePlanKey({
"usageplanId": "",
"keyId": ""
}, context)
`#### Input
* input
* usageplanId required
* keyId required #### Output
* output UsagePlanKey
$3
js
amazonaws_apigateway.UpdateUsage({
"usageplanId": "",
"keyId": ""
}, context)
`#### Input
* input
* usageplanId required
* keyId required
* patchOperations ListOfPatchOperation#### Output
* output Usage
$3
js
amazonaws_apigateway.GetUsage({
"usageplanId": ""
}, context)
`#### Input
* input
* limit
* position
* usageplanId required #### Output
* output Usage
$3
js
amazonaws_apigateway.GetVpcLinks({}, context)
`#### Input
* input
* limit
* position #### Output
* output VpcLinks
$3
js
amazonaws_apigateway.CreateVpcLink({
"name": "",
"targetArns": []
}, context)
`#### Input
* input
* description String
* name required String
* targetArns required ListOfString#### Output
Output schema unknown
$3
js
amazonaws_apigateway.DeleteVpcLink({}, context)
`#### Input
* input
* vpclinkId #### Output
Output schema unknown
$3
js
amazonaws_apigateway.GetVpcLink({}, context)
`#### Input
* input
* vpclinkId #### Output
* output VpcLink
$3
js
amazonaws_apigateway.UpdateVpcLink({}, context)
`#### Input
* input
* vpclinkId
* patchOperations ListOfPatchOperation#### Output
* output VpcLink
Definitions
$3
* AccessLogSettings : Access log settings, including the access log format and access log destination ARN.
* destinationArn String
* format String$3
* Account object: Represents an AWS account that is associated with API Gateway.
To view the account info, call GET on this resource.
Error Codes
The following exception may be thrown when the request fails.
- UnauthorizedException
- NotFoundException
- TooManyRequestsException
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
Example: Get the information about an account.
Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } }
In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.
* apiKeyVersion String
* cloudwatchRoleArn String
* features ListOfString
* throttleSettings ThrottleSettings$3
* ApiKey object: 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.
* createdDate Timestamp
* customerId String
* description String
* enabled Boolean
* id String
* lastUpdatedDate Timestamp
* name String
* stageKeys ListOfString
* value String$3
* ApiKeyIds object: The identifier of an ApiKey used in a UsagePlan.
* ids ListOfString
* warnings ListOfString$3
* ApiKeySourceType string (values: HEADER, AUTHORIZER)$3
* ApiKeys object: Represents a collection of API keys as represented by an ApiKeys resource.
* items ListOfApiKey
* position String
* warnings ListOfString$3
* ApiKeysFormat string (values: csv)$3
* ApiStage object: API stage name of the associated API stage in a usage plan.
* apiId String
* stage String$3
* Authorizer object: Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
* authType String
* authorizerCredentials String
* authorizerResultTtlInSeconds NullableInteger
* authorizerUri String
* id String
* identitySource String
* identityValidationExpression String
* name String
* providerARNs ListOfARNs
* type AuthorizerType$3
* AuthorizerType string (values: TOKEN, REQUEST, COGNITO_USER_POOLS): [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.$3
* Authorizers object: Represents a collection of Authorizer resources.
* items ListOfAuthorizer
* position String$3
* BadRequestException object: The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
* message String$3
* BasePathMapping object: Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
* basePath String
* restApiId String
* stage String$3
* BasePathMappings object: Represents a collection of BasePathMapping resources.
* items ListOfBasePathMapping
* position String$3
* Blob string$3
* Boolean $3
* CacheClusterSize (values: 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237): Returns the size of the CacheCluster.$3
* CacheClusterStatus string (values: CREATE_IN_PROGRESS, AVAILABLE, DELETE_IN_PROGRESS, NOT_AVAILABLE, FLUSH_IN_PROGRESS): Returns the status of the CacheCluster.$3
* CanarySettings object: Configuration settings of a canary deployment.
* deploymentId String
* percentTraffic Double
* stageVariableOverrides MapOfStringToString
* useStageCache Boolean$3
* ClientCertificate object: Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
* clientCertificateId String
* createdDate Timestamp
* description String
* expirationDate Timestamp
* pemEncodedCertificate String$3
* ClientCertificates object: Represents a collection of ClientCertificate resources.
* items ListOfClientCertificate
* position String$3
* ConflictException object: The request configuration has conflicts. For details, see the accompanying error message.
* message String$3
* ConnectionType string (values: INTERNET, VPC_LINK)$3
* ContentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT)$3
* CreateApiKeyRequest object: Request to create an ApiKey resource.
* customerId String
* description String
* enabled Boolean
* generateDistinctId Boolean
* name String
* stageKeys ListOfStageKeys
* value String$3
* CreateAuthorizerRequest object: Request to add a new Authorizer to an existing RestApi resource.
* authType String
* authorizerCredentials String
* authorizerResultTtlInSeconds NullableInteger
* authorizerUri String
* identitySource String
* identityValidationExpression String
* name required String
* providerARNs ListOfARNs
* type required AuthorizerType$3
* CreateBasePathMappingRequest object: Requests API Gateway to create a new BasePathMapping resource.
* basePath String
* restApiId required String
* stage String$3
* CreateDeploymentRequest object: Requests API Gateway to create a Deployment resource.
* cacheClusterEnabled NullableBoolean
* cacheClusterSize CacheClusterSize
* canarySettings DeploymentCanarySettings
* description String
* stageDescription String
* stageName String
* variables MapOfStringToString$3
* CreateDocumentationPartRequest object: Creates a new documentation part of a given API.
* location required DocumentationPartLocation
* properties required String$3
* CreateDocumentationVersionRequest object: Creates a new documentation version of a given API.
* description String
* documentationVersion required String
* stageName String$3
* CreateDomainNameRequest object: A request to create a new domain name.
* certificateArn String
* certificateBody String
* certificateChain String
* certificateName String
* certificatePrivateKey String
* domainName required String
* endpointConfiguration EndpointConfiguration
* regionalCertificateArn String
* regionalCertificateName String$3
* CreateModelRequest object: Request to add a new Model to an existing RestApi resource.
* contentType required String
* description String
* name required String
* schema String$3
* CreateRequestValidatorRequest object: Creates a RequestValidator of a given RestApi.
* name String
* validateRequestBody Boolean
* validateRequestParameters Boolean$3
* CreateResourceRequest object: Requests API Gateway to create a Resource resource.
* pathPart required String$3
* CreateRestApiRequest object: The POST Request to add a new RestApi resource to your collection.
* apiKeySource ApiKeySourceType
* binaryMediaTypes ListOfString
* cloneFrom String
* description String
* endpointConfiguration EndpointConfiguration
* minimumCompressionSize NullableInteger
* name required String
* version String$3
* CreateStageRequest object: Requests API Gateway to create a Stage resource.
* cacheClusterEnabled Boolean
* cacheClusterSize CacheClusterSize
* canarySettings CanarySettings
* deploymentId required String
* description String
* documentationVersion String
* stageName required String
* tags MapOfStringToString
* variables MapOfStringToString$3
* CreateUsagePlanKeyRequest object: The POST request to create a usage plan key for adding an existing API key to a usage plan.
* keyId required String
* keyType required String$3
* CreateUsagePlanRequest object: 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.
* apiStages ListOfApiStage
* description String
* name required String
* quota QuotaSettings
* throttle ThrottleSettings$3
* CreateVpcLinkRequest object: 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.
* description String
* name required String
* targetArns required ListOfString$3
* DeleteApiKeyRequest object: A request to delete the ApiKey resource.$3
* DeleteAuthorizerRequest object: Request to delete an existing Authorizer resource.$3
* DeleteBasePathMappingRequest object: A request to delete the BasePathMapping resource.$3
* DeleteClientCertificateRequest object: A request to delete the ClientCertificate resource.$3
* DeleteDeploymentRequest object: Requests API Gateway to delete a Deployment resource.$3
* DeleteDocumentationPartRequest object: Deletes an existing documentation part of an API.$3
* DeleteDocumentationVersionRequest object: Deletes an existing documentation version of an API.$3
* DeleteDomainNameRequest object: A request to delete the DomainName resource.$3
* DeleteGatewayResponseRequest object: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.$3
* DeleteIntegrationRequest object: Represents a delete integration request.$3
* DeleteIntegrationResponseRequest object: Represents a delete integration response request.$3
* DeleteMethodRequest object: Request to delete an existing Method resource.$3
* DeleteMethodResponseRequest object: A request to delete an existing MethodResponse resource.$3
* DeleteModelRequest object: Request to delete an existing model in an existing RestApi resource.$3
* DeleteRequestValidatorRequest object: Deletes a specified RequestValidator of a given RestApi.$3
* DeleteResourceRequest object: Request to delete a Resource.$3
* DeleteRestApiRequest object: Request to delete the specified API from your collection.$3
* DeleteStageRequest object: Requests API Gateway to delete a Stage resource.$3
* DeleteUsagePlanKeyRequest object: The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.$3
* DeleteUsagePlanRequest object: The DELETE request to delete a usage plan of a given plan Id.$3
* DeleteVpcLinkRequest object: Deletes an existing VpcLink of a specified identifier.$3
* Deployment object: 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.
To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
* apiSummary PathToMapOfMethodSnapshot
* createdDate Timestamp
* description String
* id String$3
* DeploymentCanarySettings object: The input configuration for a canary deployment.
* percentTraffic Double
* stageVariableOverrides MapOfStringToString
* useStageCache Boolean$3
* Deployments object: 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.
To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.
* items ListOfDeployment
* position String$3
* DocumentationPart object: A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
* id String
* location DocumentationPartLocation
* properties String$3
* DocumentationPartIds object: A collection of the imported DocumentationPart identifiers.
This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into API Gateway
* ids ListOfString
* warnings ListOfString$3
* DocumentationPartLocation object: Specifies the target API entity to which the documentation applies.
* method String
* name String
* path String
* statusCode DocumentationPartLocationStatusCode
* type required DocumentationPartType$3
* DocumentationPartLocationStatusCode string$3
* DocumentationPartType (values: API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY)$3
* DocumentationParts object: The collection of documentation parts of an API.
* items ListOfDocumentationPart
* position String$3
* DocumentationVersion object: A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
* createdDate Timestamp
* description String
* version String$3
* DocumentationVersions object: The collection of documentation snapshots of an API.
Use the DocumentationVersions to manage documentation snapshots associated with various API stages.
* items ListOfDocumentationVersion
* position String$3
* DomainName object: Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
* certificateArn String
* certificateName String
* certificateUploadDate Timestamp
* distributionDomainName String
* distributionHostedZoneId String
* domainName String
* endpointConfiguration EndpointConfiguration
* regionalCertificateArn String
* regionalCertificateName String
* regionalDomainName String
* regionalHostedZoneId String$3
* DomainNames object: Represents a collection of DomainName resources.
* items ListOfDomainName
* position String$3
* Double number$3
* EndpointConfiguration : The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
* types ListOfEndpointType$3
* EndpointType string (values: REGIONAL, EDGE): The endpoint type. The valid value is EDGE for edge-optimized API setup, most suitable for mobile applications, REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region$3
* ExportResponse object: The binary blob response to GetExport, which contains the generated SDK.
* body Blob$3
* FlushStageAuthorizersCacheRequest object: Request to flush authorizer cache entries on a specified stage.$3
* FlushStageCacheRequest object: Requests API Gateway to flush a stage's cache.$3
* GatewayResponse object: A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get a Gateway Response of a given response type
Request
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }
* defaultResponse Boolean
* responseParameters MapOfStringToString
* responseTemplates MapOfStringToString
* responseType GatewayResponseType
* statusCode StatusCode$3
* GatewayResponseType string (values: DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED)$3
* GatewayResponses object`: 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.
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515 The successful operation returns the 200 OK status code and a payload similar to the following:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN