5.0.0 • Published 7 years ago

@datafire/amazonaws_apigateway v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_apigateway

Client library for Amazon API Gateway

Installation and Usage

npm install --save @datafire/amazonaws_apigateway
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

GetAccount

amazonaws_apigateway.GetAccount({}, context)

Input

  • input object

Output

UpdateAccount

amazonaws_apigateway.UpdateAccount({}, context)

Input

Output

GetApiKeys

amazonaws_apigateway.GetApiKeys({}, context)

Input

  • input object
    • limit string
    • position string

Output

CreateApiKey

amazonaws_apigateway.CreateApiKey({}, context)

Input

Output

Output schema unknown

DeleteApiKey

amazonaws_apigateway.DeleteApiKey({}, context)

Input

  • input object
    • apiKey string

Output

Output schema unknown

GetApiKey

amazonaws_apigateway.GetApiKey({}, context)

Input

  • input object
    • apiKey string

Output

UpdateApiKey

amazonaws_apigateway.UpdateApiKey({}, context)

Input

Output

ImportApiKeys

amazonaws_apigateway.ImportApiKeys({
  "body": ""
}, context)

Input

  • input object

Output

Output schema unknown

GetClientCertificates

amazonaws_apigateway.GetClientCertificates({}, context)

Input

  • input object
    • limit string
    • position string

Output

GenerateClientCertificate

amazonaws_apigateway.GenerateClientCertificate({}, context)

Input

  • input object

Output

Output schema unknown

DeleteClientCertificate

amazonaws_apigateway.DeleteClientCertificate({}, context)

Input

  • input object
    • clientcertificateId string

Output

Output schema unknown

GetClientCertificate

amazonaws_apigateway.GetClientCertificate({}, context)

Input

  • input object
    • clientcertificateId string

Output

UpdateClientCertificate

amazonaws_apigateway.UpdateClientCertificate({}, context)

Input

Output

GetDomainNames

amazonaws_apigateway.GetDomainNames({}, context)

Input

  • input object
    • limit string
    • position string

Output

CreateDomainName

amazonaws_apigateway.CreateDomainName({
  "domainName": ""
}, context)

Input

Output

Output schema unknown

DeleteDomainName

amazonaws_apigateway.DeleteDomainName({}, context)

Input

  • input object
    • domainName string

Output

Output schema unknown

GetDomainName

amazonaws_apigateway.GetDomainName({}, context)

Input

  • input object
    • domainName string

Output

UpdateDomainName

amazonaws_apigateway.UpdateDomainName({}, context)

Input

Output

GetBasePathMappings

amazonaws_apigateway.GetBasePathMappings({}, context)

Input

  • input object
    • limit string
    • position string
    • domainName string

Output

CreateBasePathMapping

amazonaws_apigateway.CreateBasePathMapping({
  "restApiId": ""
}, context)

Input

Output

Output schema unknown

DeleteBasePathMapping

amazonaws_apigateway.DeleteBasePathMapping({}, context)

Input

  • input object
    • domainName string
    • basePath string

Output

Output schema unknown

GetBasePathMapping

amazonaws_apigateway.GetBasePathMapping({}, context)

Input

  • input object
    • domainName string
    • basePath string

Output

UpdateBasePathMapping

amazonaws_apigateway.UpdateBasePathMapping({}, context)

Input

Output

GetRestApis

amazonaws_apigateway.GetRestApis({}, context)

Input

  • input object
    • limit string
    • position string

Output

CreateRestApi

amazonaws_apigateway.CreateRestApi({
  "name": ""
}, context)

Input

Output

Output schema unknown

DeleteRestApi

amazonaws_apigateway.DeleteRestApi({}, context)

Input

  • input object
    • restapiId string

Output

Output schema unknown

GetRestApi

amazonaws_apigateway.GetRestApi({}, context)

Input

  • input object
    • restapiId string

Output

UpdateRestApi

amazonaws_apigateway.UpdateRestApi({}, context)

Input

Output

PutRestApi

amazonaws_apigateway.PutRestApi({
  "body": ""
}, context)

Input

  • input object
    • restapiId string
    • body required Blob

Output

GetAuthorizers

amazonaws_apigateway.GetAuthorizers({}, context)

Input

  • input object
    • restapiId string

Output

CreateAuthorizer

amazonaws_apigateway.CreateAuthorizer({
  "name": "",
  "type": ""
}, context)

Input

Output

Output schema unknown

DeleteAuthorizer

amazonaws_apigateway.DeleteAuthorizer({}, context)

Input

  • input object
    • restapiId string
    • authorizerId string

Output

Output schema unknown

GetAuthorizer

amazonaws_apigateway.GetAuthorizer({}, context)

Input

  • input object
    • restapiId string
    • authorizerId string

Output

UpdateAuthorizer

amazonaws_apigateway.UpdateAuthorizer({}, context)

Input

Output

TestInvokeAuthorizer

amazonaws_apigateway.TestInvokeAuthorizer({}, context)

Input

Output

GetDeployments

amazonaws_apigateway.GetDeployments({}, context)

Input

  • input object
    • limit string
    • position string
    • restapiId string

Output

CreateDeployment

amazonaws_apigateway.CreateDeployment({}, context)

Input

Output

Output schema unknown

DeleteDeployment

amazonaws_apigateway.DeleteDeployment({}, context)

Input

  • input object
    • restapiId string
    • deploymentId string

Output

Output schema unknown

GetDeployment

amazonaws_apigateway.GetDeployment({}, context)

Input

  • input object
    • restapiId string
    • deploymentId string

Output

UpdateDeployment

amazonaws_apigateway.UpdateDeployment({}, context)

Input

Output

GetDocumentationParts

amazonaws_apigateway.GetDocumentationParts({}, context)

Input

  • input object
    • restapiId string

Output

CreateDocumentationPart

amazonaws_apigateway.CreateDocumentationPart({
  "location": {
    "type": ""
  },
  "properties": ""
}, context)

Input

Output

Output schema unknown

ImportDocumentationParts

amazonaws_apigateway.ImportDocumentationParts({
  "body": ""
}, context)

Input

  • input object
    • restapiId string
    • body required Blob

Output

DeleteDocumentationPart

amazonaws_apigateway.DeleteDocumentationPart({}, context)

Input

  • input object
    • restapiId string
    • partId string

Output

Output schema unknown

GetDocumentationPart

amazonaws_apigateway.GetDocumentationPart({}, context)

Input

  • input object
    • restapiId string
    • partId string

Output

UpdateDocumentationPart

amazonaws_apigateway.UpdateDocumentationPart({}, context)

Input

Output

GetDocumentationVersions

amazonaws_apigateway.GetDocumentationVersions({}, context)

Input

  • input object
    • restapiId string

Output

CreateDocumentationVersion

amazonaws_apigateway.CreateDocumentationVersion({
  "documentationVersion": ""
}, context)

Input

  • input object

Output

Output schema unknown

DeleteDocumentationVersion

amazonaws_apigateway.DeleteDocumentationVersion({}, context)

Input

  • input object
    • restapiId string
    • docVersion string

Output

Output schema unknown

GetDocumentationVersion

amazonaws_apigateway.GetDocumentationVersion({}, context)

Input

  • input object
    • restapiId string
    • docVersion string

Output

UpdateDocumentationVersion

amazonaws_apigateway.UpdateDocumentationVersion({}, context)

Input

Output

GetGatewayResponses

amazonaws_apigateway.GetGatewayResponses({}, context)

Input

  • input object
    • restapiId string

Output

DeleteGatewayResponse

amazonaws_apigateway.DeleteGatewayResponse({}, context)

Input

  • input object
    • restapiId string
    • responseType string

Output

Output schema unknown

GetGatewayResponse

amazonaws_apigateway.GetGatewayResponse({}, context)

Input

  • input object
    • restapiId string
    • responseType string

Output

UpdateGatewayResponse

amazonaws_apigateway.UpdateGatewayResponse({}, context)

Input

Output

PutGatewayResponse

amazonaws_apigateway.PutGatewayResponse({}, context)

Input

Output

Output schema unknown

GetModels

amazonaws_apigateway.GetModels({}, context)

Input

  • input object
    • limit string
    • position string
    • restapiId string

Output

CreateModel

amazonaws_apigateway.CreateModel({
  "name": "",
  "contentType": ""
}, context)

Input

Output

Output schema unknown

DeleteModel

amazonaws_apigateway.DeleteModel({}, context)

Input

  • input object
    • restapiId string
    • modelName string

Output

Output schema unknown

GetModel

amazonaws_apigateway.GetModel({}, context)

Input

  • input object
    • restapiId string
    • modelName string

Output

UpdateModel

amazonaws_apigateway.UpdateModel({}, context)

Input

Output

GetModelTemplate

amazonaws_apigateway.GetModelTemplate({}, context)

Input

  • input object
    • restapiId string
    • modelName string

Output

GetRequestValidators

amazonaws_apigateway.GetRequestValidators({}, context)

Input

  • input object
    • restapiId string

Output

CreateRequestValidator

amazonaws_apigateway.CreateRequestValidator({}, context)

Input

Output

Output schema unknown

DeleteRequestValidator

amazonaws_apigateway.DeleteRequestValidator({}, context)

Input

  • input object
    • restapiId string
    • requestvalidatorId string

Output

Output schema unknown

GetRequestValidator

amazonaws_apigateway.GetRequestValidator({}, context)

Input

  • input object
    • restapiId string
    • requestvalidatorId string

Output

UpdateRequestValidator

amazonaws_apigateway.UpdateRequestValidator({}, context)

Input

Output

GetResources

amazonaws_apigateway.GetResources({}, context)

Input

  • input object
    • limit string
    • position string
    • restapiId string

Output

CreateResource

amazonaws_apigateway.CreateResource({
  "pathPart": ""
}, context)

Input

  • input object
    • restapiId string
    • parentId string
    • pathPart required String

Output

Output schema unknown

DeleteResource

amazonaws_apigateway.DeleteResource({}, context)

Input

  • input object
    • restapiId string
    • resourceId string

Output

Output schema unknown

GetResource

amazonaws_apigateway.GetResource({}, context)

Input

  • input object
    • restapiId string
    • resourceId string

Output

UpdateResource

amazonaws_apigateway.UpdateResource({}, context)

Input

Output

DeleteMethod

amazonaws_apigateway.DeleteMethod({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string

Output

Output schema unknown

GetMethod

amazonaws_apigateway.GetMethod({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string

Output

UpdateMethod

amazonaws_apigateway.UpdateMethod({}, context)

Input

Output

TestInvokeMethod

amazonaws_apigateway.TestInvokeMethod({}, context)

Input

Output

PutMethod

amazonaws_apigateway.PutMethod({
  "authorizationType": ""
}, context)

Input

Output

Output schema unknown

DeleteIntegration

amazonaws_apigateway.DeleteIntegration({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string

Output

Output schema unknown

GetIntegration

amazonaws_apigateway.GetIntegration({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string

Output

UpdateIntegration

amazonaws_apigateway.UpdateIntegration({}, context)

Input

Output

PutIntegration

amazonaws_apigateway.PutIntegration({
  "type": ""
}, context)

Input

Output

Output schema unknown

DeleteIntegrationResponse

amazonaws_apigateway.DeleteIntegrationResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string

Output

Output schema unknown

GetIntegrationResponse

amazonaws_apigateway.GetIntegrationResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string

Output

UpdateIntegrationResponse

amazonaws_apigateway.UpdateIntegrationResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string
    • patchOperations ListOfPatchOperation

Output

PutIntegrationResponse

amazonaws_apigateway.PutIntegrationResponse({}, context)

Input

Output

Output schema unknown

DeleteMethodResponse

amazonaws_apigateway.DeleteMethodResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string

Output

Output schema unknown

GetMethodResponse

amazonaws_apigateway.GetMethodResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string

Output

UpdateMethodResponse

amazonaws_apigateway.UpdateMethodResponse({}, context)

Input

  • input object
    • restapiId string
    • resourceId string
    • httpMethod string
    • statusCode string
    • patchOperations ListOfPatchOperation

Output

Output schema unknown

PutMethodResponse

amazonaws_apigateway.PutMethodResponse({}, context)

Input

Output

Output schema unknown

GetStages

amazonaws_apigateway.GetStages({}, context)

Input

  • input object
    • restapiId string

Output

CreateStage

amazonaws_apigateway.CreateStage({
  "stageName": "",
  "deploymentId": ""
}, context)

Input

Output

Output schema unknown

DeleteStage

amazonaws_apigateway.DeleteStage({}, context)

Input

  • input object
    • restapiId string
    • stageName string

Output

Output schema unknown

GetStage

amazonaws_apigateway.GetStage({}, context)

Input

  • input object
    • restapiId string
    • stageName string

Output

UpdateStage

amazonaws_apigateway.UpdateStage({}, context)

Input

Output

FlushStageAuthorizersCache

amazonaws_apigateway.FlushStageAuthorizersCache({}, context)

Input

  • input object
    • restapiId string
    • stageName string

Output

Output schema unknown

FlushStageCache

amazonaws_apigateway.FlushStageCache({}, context)

Input

  • input object
    • restapiId string
    • stageName string

Output

Output schema unknown

GetExport

amazonaws_apigateway.GetExport({}, context)

Input

  • input object
    • restapiId string
    • stageName string
    • exportType string

Output

GetSdk

amazonaws_apigateway.GetSdk({}, context)

Input

  • input object
    • restapiId string
    • stageName string
    • sdkType string

Output

ImportRestApi

amazonaws_apigateway.ImportRestApi({
  "body": ""
}, context)

Input

  • input object

Output

Output schema unknown

GetSdkTypes

amazonaws_apigateway.GetSdkTypes({}, context)

Input

  • input object

Output

GetSdkType

amazonaws_apigateway.GetSdkType({}, context)

Input

  • input object
    • sdktypeId string

Output

UntagResource

amazonaws_apigateway.UntagResource({}, context)

Input

  • input object
    • resourceArn string

Output

Output schema unknown

GetTags

amazonaws_apigateway.GetTags({}, context)

Input

  • input object
    • resourceArn string

Output

TagResource

amazonaws_apigateway.TagResource({
  "tags": []
}, context)

Input

Output

Output schema unknown

GetUsagePlans

amazonaws_apigateway.GetUsagePlans({}, context)

Input

  • input object
    • limit string
    • position string

Output

CreateUsagePlan

amazonaws_apigateway.CreateUsagePlan({
  "name": ""
}, context)

Input

Output

Output schema unknown

DeleteUsagePlan

amazonaws_apigateway.DeleteUsagePlan({
  "usageplanId": ""
}, context)

Input

  • input object
    • usageplanId required string

Output

Output schema unknown

GetUsagePlan

amazonaws_apigateway.GetUsagePlan({
  "usageplanId": ""
}, context)

Input

  • input object
    • usageplanId required string

Output

UpdateUsagePlan

amazonaws_apigateway.UpdateUsagePlan({
  "usageplanId": ""
}, context)

Input

Output

GetUsagePlanKeys

amazonaws_apigateway.GetUsagePlanKeys({
  "usageplanId": ""
}, context)

Input

  • input object
    • limit string
    • position string
    • usageplanId required string

Output

CreateUsagePlanKey

amazonaws_apigateway.CreateUsagePlanKey({
  "usageplanId": "",
  "keyId": "",
  "keyType": ""
}, context)

Input

  • input object
    • usageplanId required string
    • keyId required String
    • keyType required String

Output

Output schema unknown

DeleteUsagePlanKey

amazonaws_apigateway.DeleteUsagePlanKey({
  "usageplanId": "",
  "keyId": ""
}, context)

Input

  • input object
    • usageplanId required string
    • keyId required string

Output

Output schema unknown

GetUsagePlanKey

amazonaws_apigateway.GetUsagePlanKey({
  "usageplanId": "",
  "keyId": ""
}, context)

Input

  • input object
    • usageplanId required string
    • keyId required string

Output

UpdateUsage

amazonaws_apigateway.UpdateUsage({
  "usageplanId": "",
  "keyId": ""
}, context)

Input

Output

GetUsage

amazonaws_apigateway.GetUsage({
  "usageplanId": ""
}, context)

Input

  • input object
    • limit string
    • position string
    • usageplanId required string

Output

GetVpcLinks

amazonaws_apigateway.GetVpcLinks({}, context)

Input

  • input object
    • limit string
    • position string

Output

CreateVpcLink

amazonaws_apigateway.CreateVpcLink({
  "name": "",
  "targetArns": []
}, context)

Input

Output

Output schema unknown

DeleteVpcLink

amazonaws_apigateway.DeleteVpcLink({}, context)

Input

  • input object
    • vpclinkId string

Output

Output schema unknown

GetVpcLink

amazonaws_apigateway.GetVpcLink({}, context)

Input

  • input object
    • vpclinkId string

Output

UpdateVpcLink

amazonaws_apigateway.UpdateVpcLink({}, context)

Input

Output

Definitions

AccessLogSettings

  • AccessLogSettings object: Access log settings, including the access log format and access log destination ARN.

Account

  • 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. API Gateway Limits Developer Guide, AWS CLI

ApiKey

  • 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. Use API Keys

ApiKeyIds

ApiKeySourceType

  • ApiKeySourceType string (values: HEADER, AUTHORIZER)

ApiKeys

  • ApiKeys object: Represents a collection of API keys as represented by an ApiKeys resource. Use API Keys

ApiKeysFormat

  • ApiKeysFormat string (values: csv)

ApiStage

  • ApiStage object: API stage name of the associated API stage in a usage plan.

Authorizer

  • 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. Enable custom authorization

AuthorizerType

  • 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.

Authorizers

  • Authorizers object: Represents a collection of Authorizer resources. Enable custom authorization

BadRequestException

  • BadRequestException object: The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

BasePathMapping

  • 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. Use Custom Domain Names

BasePathMappings

  • BasePathMappings object: Represents a collection of BasePathMapping resources. Use Custom Domain Names

Blob

  • Blob string

Boolean

  • Boolean boolean

CacheClusterSize

  • CacheClusterSize string (values: 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237): Returns the size of the CacheCluster.

CacheClusterStatus

  • CacheClusterStatus string (values: CREATE_IN_PROGRESS, AVAILABLE, DELETE_IN_PROGRESS, NOT_AVAILABLE, FLUSH_IN_PROGRESS): Returns the status of the CacheCluster.

CanarySettings

ClientCertificate

  • 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. Use Client-Side Certificate

ClientCertificates

  • ClientCertificates object: Represents a collection of ClientCertificate resources. Use Client-Side Certificate

ConflictException

  • ConflictException object: The request configuration has conflicts. For details, see the accompanying error message.

ConnectionType

  • ConnectionType string (values: INTERNET, VPC_LINK)

ContentHandlingStrategy

  • ContentHandlingStrategy string (values: CONVERT_TO_BINARY, CONVERT_TO_TEXT)

CreateApiKeyRequest

CreateAuthorizerRequest

CreateBasePathMappingRequest

  • CreateBasePathMappingRequest object: Requests API Gateway to create a new BasePathMapping resource.

CreateDeploymentRequest

CreateDocumentationPartRequest

  • CreateDocumentationPartRequest object: Creates a new documentation part of a given API.

CreateDocumentationVersionRequest

  • CreateDocumentationVersionRequest object: Creates a new documentation version of a given API.

CreateDomainNameRequest

CreateModelRequest

  • CreateModelRequest object: Request to add a new Model to an existing RestApi resource.

CreateRequestValidatorRequest

  • CreateRequestValidatorRequest object: Creates a RequestValidator of a given RestApi.

CreateResourceRequest

  • CreateResourceRequest object: Requests API Gateway to create a Resource resource.

CreateRestApiRequest

CreateStageRequest

CreateUsagePlanKeyRequest

  • CreateUsagePlanKeyRequest object: The POST request to create a usage plan key for adding an existing API key to a usage plan.

CreateUsagePlanRequest

  • 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.

CreateVpcLinkRequest

  • 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.

DeleteApiKeyRequest

  • DeleteApiKeyRequest object: A request to delete the ApiKey resource.

DeleteAuthorizerRequest

  • DeleteAuthorizerRequest object: Request to delete an existing Authorizer resource.

DeleteBasePathMappingRequest

  • DeleteBasePathMappingRequest object: A request to delete the BasePathMapping resource.

DeleteClientCertificateRequest

  • DeleteClientCertificateRequest object: A request to delete the ClientCertificate resource.

DeleteDeploymentRequest

  • DeleteDeploymentRequest object: Requests API Gateway to delete a Deployment resource.

DeleteDocumentationPartRequest

  • DeleteDocumentationPartRequest object: Deletes an existing documentation part of an API.

DeleteDocumentationVersionRequest

  • DeleteDocumentationVersionRequest object: Deletes an existing documentation version of an API.

DeleteDomainNameRequest

  • DeleteDomainNameRequest object: A request to delete the DomainName resource.

DeleteGatewayResponseRequest

  • DeleteGatewayResponseRequest object: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

DeleteIntegrationRequest

  • DeleteIntegrationRequest object: Represents a delete integration request.

DeleteIntegrationResponseRequest

  • DeleteIntegrationResponseRequest object: Represents a delete integration response request.

DeleteMethodRequest

  • DeleteMethodRequest object: Request to delete an existing Method resource.

DeleteMethodResponseRequest

  • DeleteMethodResponseRequest object: A request to delete an existing MethodResponse resource.

DeleteModelRequest

  • DeleteModelRequest object: Request to delete an existing model in an existing RestApi resource.

DeleteRequestValidatorRequest

  • DeleteRequestValidatorRequest object: Deletes a specified RequestValidator of a given RestApi.

DeleteResourceRequest

  • DeleteResourceRequest object: Request to delete a Resource.

DeleteRestApiRequest

  • DeleteRestApiRequest object: Request to delete the specified API from your collection.

DeleteStageRequest

  • DeleteStageRequest object: Requests API Gateway to delete a Stage resource.

DeleteUsagePlanKeyRequest

  • DeleteUsagePlanKeyRequest object: The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

DeleteUsagePlanRequest

  • DeleteUsagePlanRequest object: The DELETE request to delete a usage plan of a given plan Id.

DeleteVpcLinkRequest

  • DeleteVpcLinkRequest object: Deletes an existing VpcLink of a specified identifier.

Deployment

  • 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}). RestApi, Deployments, Stage, AWS CLI, AWS SDKs

DeploymentCanarySettings

  • DeploymentCanarySettings object: The input configuration for a canary deployment.

Deployments

  • 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. Deploying an API, AWS CLI, AWS SDKs

DocumentationPart

  • 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. Documenting an API, DocumentationParts

DocumentationPartIds

  • 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 Documenting an API, documentationpart:import, DocumentationPart

DocumentationPartLocation

DocumentationPartLocationStatusCode

  • DocumentationPartLocationStatusCode string

DocumentationPartType

  • DocumentationPartType string (values: API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY)

DocumentationParts

  • DocumentationParts object: The collection of documentation parts of an API. Documenting an API, DocumentationPart

DocumentationVersion

  • 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. Documenting an API, DocumentationPart, DocumentationVersions

DocumentationVersions

  • DocumentationVersions object: The collection of documentation snapshots of an API. Use the DocumentationVersions to manage documentation snapshots associated with various API stages. Documenting an API, DocumentationPart, DocumentationVersion

DomainName

  • 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. Set a Custom Host Name for an API

DomainNames

  • DomainNames object: Represents a collection of DomainName resources. Use Client-Side Certificate

Double

  • Double number

EndpointConfiguration

  • EndpointConfiguration object: The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

EndpointType

  • 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

ExportResponse

  • ExportResponse object: The binary blob response to GetExport, which contains the generated SDK.

FlushStageAuthorizersCacheRequest

  • FlushStageAuthorizersCacheRequest object: Request to flush authorizer cache entries on a specified stage.

FlushStageCacheRequest

  • FlushStageCacheRequest object: Requests API Gateway to flush a stage's cache.

GatewayResponse

  • 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" } Customize Gateway Responses

GatewayResponseType

  • 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)

GatewayResponses

  • 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. For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get the collection of gateway responses of an API Request 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 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" }, "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
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago