models.apigateway-2015-07-09-intermediate.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-api-gateway Show documentation
Show all versions of aws-java-sdk-api-gateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating with Amazon API Gateway
{
"customizationConfig" : {
"additionalShapeConstructors" : null,
"authPolicyActions" : {
"actionPrefix" : null,
"fileNamePrefix" : null,
"skip" : true
},
"calculateCRC32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customClientConfigFactory" : null,
"customCodeTemplates" : null,
"customErrorCodeFieldName" : null,
"customExceptionUnmarshallerImpl" : null,
"customFileHeader" : null,
"customResponseMetadataClassName" : null,
"customServiceMetadata" : null,
"customServiceNameForRequest" : null,
"customSignerProvider" : null,
"operationModifiers" : null,
"operationsWithResponseStreamContentLengthValidation" : null,
"renameShapes" : null,
"requestMetrics" : null,
"requiredParamValidationEnabled" : false,
"sdkModeledExceptionBaseClassName" : null,
"sendEmptyAutoConstructedListAsEmptyList" : null,
"sendExplicitlyEmptyListsForQuery" : false,
"serviceClientHoldInputStream" : false,
"shapeModifiers" : null,
"shapeSubstitutions" : {
"CacheClusterSize" : {
"emitAsShape" : "String",
"emitFromMember" : null,
"skipMarshallPathForShapes" : null
}
},
"simpleMethods" : null,
"skipInterfaceAdditions" : false,
"skipSmokeTests" : false,
"useAutoConstructList" : false,
"useAutoConstructMap" : false
},
"metadata" : {
"apiVersion" : "2015-07-09",
"asyncClient" : "AmazonApiGatewayAsyncClient",
"asyncClientBuilderClassName" : "AmazonApiGatewayAsyncClientBuilder",
"asyncInterface" : "AmazonApiGatewayAsync",
"cborProtocol" : false,
"checksumFormat" : null,
"contentType" : "",
"cucumberModuleInjectorClassName" : "AmazonApiGatewayModuleInjector",
"defaultEndpoint" : "https://apigateway.us-east-1.amazonaws.com",
"defaultEndpointWithoutHttpProtocol" : "apigateway.us-east-1.amazonaws.com",
"documentation" : "Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon 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.
",
"endpointPrefix" : "apigateway",
"hasApiWithStreamInput" : false,
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"packageName" : "com.amazonaws.services.apigateway",
"packagePath" : "com/amazonaws/services/apigateway",
"protocol" : "rest-json",
"protocolDefaultExceptionUmarshallerImpl" : null,
"serviceAbbreviation" : null,
"serviceFullName" : "Amazon API Gateway",
"serviceName" : "Amazon API Gateway",
"signingName" : "apigateway",
"smokeTestsPackageName" : "com.amazonaws.services.apigateway.smoketests",
"syncClient" : "AmazonApiGatewayClient",
"syncClientBuilderClassName" : "AmazonApiGatewayClientBuilder",
"syncInterface" : "AmazonApiGateway",
"unmarshallerClassSuffix" : "JsonUnmarshaller",
"unmarshallerContextClassName" : "JsonUnmarshallerContext",
"xmlProtocol" : false
},
"operations" : {
"CreateApiKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateApiKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Create an ApiKey resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateApiKeyRequest",
"variableName" : "createApiKeyRequest",
"variableType" : "CreateApiKeyRequest",
"documentation" : "Request to create an ApiKey resource.
",
"simpleType" : "CreateApiKeyRequest",
"variableSetterType" : "CreateApiKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createApiKey",
"operationName" : "CreateApiKey",
"returnType" : {
"returnType" : "CreateApiKeyResult",
"documentation" : "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.
"
},
"syncReturnType" : "CreateApiKeyResult"
},
"CreateAuthorizer" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateAuthorizerResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a new Authorizer resource to an existing RestApi resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateAuthorizerRequest",
"variableName" : "createAuthorizerRequest",
"variableType" : "CreateAuthorizerRequest",
"documentation" : "Request to add a new Authorizer to an existing RestApi resource.
",
"simpleType" : "CreateAuthorizerRequest",
"variableSetterType" : "CreateAuthorizerRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createAuthorizer",
"operationName" : "CreateAuthorizer",
"returnType" : {
"returnType" : "CreateAuthorizerResult",
"documentation" : "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
"
},
"syncReturnType" : "CreateAuthorizerResult"
},
"CreateBasePathMapping" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateBasePathMappingResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new BasePathMapping resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateBasePathMappingRequest",
"variableName" : "createBasePathMappingRequest",
"variableType" : "CreateBasePathMappingRequest",
"documentation" : "Requests Amazon API Gateway to create a new BasePathMapping resource.
",
"simpleType" : "CreateBasePathMappingRequest",
"variableSetterType" : "CreateBasePathMappingRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createBasePathMapping",
"operationName" : "CreateBasePathMapping",
"returnType" : {
"returnType" : "CreateBasePathMappingResult",
"documentation" : "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. "
},
"syncReturnType" : "CreateBasePathMappingResult"
},
"CreateDeployment" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateDeploymentResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDeploymentRequest",
"variableName" : "createDeploymentRequest",
"variableType" : "CreateDeploymentRequest",
"documentation" : "Requests Amazon API Gateway to create a Deployment resource.
",
"simpleType" : "CreateDeploymentRequest",
"variableSetterType" : "CreateDeploymentRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDeployment",
"operationName" : "CreateDeployment",
"returnType" : {
"returnType" : "CreateDeploymentResult",
"documentation" : "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}). "
},
"syncReturnType" : "CreateDeploymentResult"
},
"CreateDomainName" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateDomainNameResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new domain name.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDomainNameRequest",
"variableName" : "createDomainNameRequest",
"variableType" : "CreateDomainNameRequest",
"documentation" : "A request to create a new domain name.
",
"simpleType" : "CreateDomainNameRequest",
"variableSetterType" : "CreateDomainNameRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createDomainName",
"operationName" : "CreateDomainName",
"returnType" : {
"returnType" : "CreateDomainNameResult",
"documentation" : "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
"
},
"syncReturnType" : "CreateDomainNameResult"
},
"CreateModel" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateModelResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a new Model resource to an existing RestApi resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateModelRequest",
"variableName" : "createModelRequest",
"variableType" : "CreateModelRequest",
"documentation" : "Request to add a new Model to an existing RestApi resource.
",
"simpleType" : "CreateModelRequest",
"variableSetterType" : "CreateModelRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createModel",
"operationName" : "CreateModel",
"returnType" : {
"returnType" : "CreateModelResult",
"documentation" : "Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
"
},
"syncReturnType" : "CreateModelResult"
},
"CreateResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a Resource resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateResourceRequest",
"variableName" : "createResourceRequest",
"variableType" : "CreateResourceRequest",
"documentation" : "Requests Amazon API Gateway to create a Resource resource.
",
"simpleType" : "CreateResourceRequest",
"variableSetterType" : "CreateResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createResource",
"operationName" : "CreateResource",
"returnType" : {
"returnType" : "CreateResourceResult",
"documentation" : "Represents an API resource.
"
},
"syncReturnType" : "CreateResourceResult"
},
"CreateRestApi" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateRestApiResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new RestApi resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateRestApiRequest",
"variableName" : "createRestApiRequest",
"variableType" : "CreateRestApiRequest",
"documentation" : "The POST Request to add a new RestApi resource to your collection.
",
"simpleType" : "CreateRestApiRequest",
"variableSetterType" : "CreateRestApiRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createRestApi",
"operationName" : "CreateRestApi",
"returnType" : {
"returnType" : "CreateRestApiResult",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "CreateRestApiResult"
},
"CreateStage" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateStageResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new Stage resource that references a pre-existing Deployment for the API.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateStageRequest",
"variableName" : "createStageRequest",
"variableType" : "CreateStageRequest",
"documentation" : "Requests Amazon API Gateway to create a Stage resource.
",
"simpleType" : "CreateStageRequest",
"variableSetterType" : "CreateStageRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createStage",
"operationName" : "CreateStage",
"returnType" : {
"returnType" : "CreateStageResult",
"documentation" : "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
"
},
"syncReturnType" : "CreateStageResult"
},
"CreateUsagePlan" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateUsagePlanResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUsagePlanRequest",
"variableName" : "createUsagePlanRequest",
"variableType" : "CreateUsagePlanRequest",
"documentation" : "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.
",
"simpleType" : "CreateUsagePlanRequest",
"variableSetterType" : "CreateUsagePlanRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createUsagePlan",
"operationName" : "CreateUsagePlan",
"returnType" : {
"returnType" : "CreateUsagePlanResult",
"documentation" : "Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
"
},
"syncReturnType" : "CreateUsagePlanResult"
},
"CreateUsagePlanKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateUsagePlanKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a usage plan key for adding an existing API key to a usage plan.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUsagePlanKeyRequest",
"variableName" : "createUsagePlanKeyRequest",
"variableType" : "CreateUsagePlanKeyRequest",
"documentation" : "The POST request to create a usage plan key for adding an existing API key to a usage plan.
",
"simpleType" : "CreateUsagePlanKeyRequest",
"variableSetterType" : "CreateUsagePlanKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createUsagePlanKey",
"operationName" : "CreateUsagePlanKey",
"returnType" : {
"returnType" : "CreateUsagePlanKeyResult",
"documentation" : "Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
\" "
},
"syncReturnType" : "CreateUsagePlanKeyResult"
},
"DeleteApiKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteApiKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the ApiKey resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteApiKeyRequest",
"variableName" : "deleteApiKeyRequest",
"variableType" : "DeleteApiKeyRequest",
"documentation" : "A request to delete the ApiKey resource.
",
"simpleType" : "DeleteApiKeyRequest",
"variableSetterType" : "DeleteApiKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteApiKey",
"operationName" : "DeleteApiKey",
"returnType" : {
"returnType" : "DeleteApiKeyResult",
"documentation" : null
},
"syncReturnType" : "DeleteApiKeyResult"
},
"DeleteAuthorizer" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteAuthorizerResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing Authorizer resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteAuthorizerRequest",
"variableName" : "deleteAuthorizerRequest",
"variableType" : "DeleteAuthorizerRequest",
"documentation" : "Request to delete an existing Authorizer resource.
",
"simpleType" : "DeleteAuthorizerRequest",
"variableSetterType" : "DeleteAuthorizerRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteAuthorizer",
"operationName" : "DeleteAuthorizer",
"returnType" : {
"returnType" : "DeleteAuthorizerResult",
"documentation" : null
},
"syncReturnType" : "DeleteAuthorizerResult"
},
"DeleteBasePathMapping" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteBasePathMappingResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the BasePathMapping resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteBasePathMappingRequest",
"variableName" : "deleteBasePathMappingRequest",
"variableType" : "DeleteBasePathMappingRequest",
"documentation" : "A request to delete the BasePathMapping resource.
",
"simpleType" : "DeleteBasePathMappingRequest",
"variableSetterType" : "DeleteBasePathMappingRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteBasePathMapping",
"operationName" : "DeleteBasePathMapping",
"returnType" : {
"returnType" : "DeleteBasePathMappingResult",
"documentation" : null
},
"syncReturnType" : "DeleteBasePathMappingResult"
},
"DeleteClientCertificate" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteClientCertificateResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the ClientCertificate resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteClientCertificateRequest",
"variableName" : "deleteClientCertificateRequest",
"variableType" : "DeleteClientCertificateRequest",
"documentation" : "A request to delete the ClientCertificate resource.
",
"simpleType" : "DeleteClientCertificateRequest",
"variableSetterType" : "DeleteClientCertificateRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteClientCertificate",
"operationName" : "DeleteClientCertificate",
"returnType" : {
"returnType" : "DeleteClientCertificateResult",
"documentation" : null
},
"syncReturnType" : "DeleteClientCertificateResult"
},
"DeleteDeployment" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDeploymentResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDeploymentRequest",
"variableName" : "deleteDeploymentRequest",
"variableType" : "DeleteDeploymentRequest",
"documentation" : "Requests Amazon API Gateway to delete a Deployment resource.
",
"simpleType" : "DeleteDeploymentRequest",
"variableSetterType" : "DeleteDeploymentRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDeployment",
"operationName" : "DeleteDeployment",
"returnType" : {
"returnType" : "DeleteDeploymentResult",
"documentation" : null
},
"syncReturnType" : "DeleteDeploymentResult"
},
"DeleteDomainName" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteDomainNameResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the DomainName resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDomainNameRequest",
"variableName" : "deleteDomainNameRequest",
"variableType" : "DeleteDomainNameRequest",
"documentation" : "A request to delete the DomainName resource.
",
"simpleType" : "DeleteDomainNameRequest",
"variableSetterType" : "DeleteDomainNameRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteDomainName",
"operationName" : "DeleteDomainName",
"returnType" : {
"returnType" : "DeleteDomainNameResult",
"documentation" : null
},
"syncReturnType" : "DeleteDomainNameResult"
},
"DeleteIntegration" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteIntegrationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a delete integration.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteIntegrationRequest",
"variableName" : "deleteIntegrationRequest",
"variableType" : "DeleteIntegrationRequest",
"documentation" : "Represents a delete integration request.
",
"simpleType" : "DeleteIntegrationRequest",
"variableSetterType" : "DeleteIntegrationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteIntegration",
"operationName" : "DeleteIntegration",
"returnType" : {
"returnType" : "DeleteIntegrationResult",
"documentation" : null
},
"syncReturnType" : "DeleteIntegrationResult"
},
"DeleteIntegrationResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteIntegrationResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a delete integration response.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteIntegrationResponseRequest",
"variableName" : "deleteIntegrationResponseRequest",
"variableType" : "DeleteIntegrationResponseRequest",
"documentation" : "Represents a delete integration response request.
",
"simpleType" : "DeleteIntegrationResponseRequest",
"variableSetterType" : "DeleteIntegrationResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteIntegrationResponse",
"operationName" : "DeleteIntegrationResponse",
"returnType" : {
"returnType" : "DeleteIntegrationResponseResult",
"documentation" : null
},
"syncReturnType" : "DeleteIntegrationResponseResult"
},
"DeleteMethod" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteMethodResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing Method resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteMethodRequest",
"variableName" : "deleteMethodRequest",
"variableType" : "DeleteMethodRequest",
"documentation" : "Request to delete an existing Method resource.
",
"simpleType" : "DeleteMethodRequest",
"variableSetterType" : "DeleteMethodRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteMethod",
"operationName" : "DeleteMethod",
"returnType" : {
"returnType" : "DeleteMethodResult",
"documentation" : null
},
"syncReturnType" : "DeleteMethodResult"
},
"DeleteMethodResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteMethodResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing MethodResponse resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteMethodResponseRequest",
"variableName" : "deleteMethodResponseRequest",
"variableType" : "DeleteMethodResponseRequest",
"documentation" : "A request to delete an existing MethodResponse resource.
",
"simpleType" : "DeleteMethodResponseRequest",
"variableSetterType" : "DeleteMethodResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteMethodResponse",
"operationName" : "DeleteMethodResponse",
"returnType" : {
"returnType" : "DeleteMethodResponseResult",
"documentation" : null
},
"syncReturnType" : "DeleteMethodResponseResult"
},
"DeleteModel" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteModelResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a model.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteModelRequest",
"variableName" : "deleteModelRequest",
"variableType" : "DeleteModelRequest",
"documentation" : "Request to delete an existing model in an existing RestApi resource.
",
"simpleType" : "DeleteModelRequest",
"variableSetterType" : "DeleteModelRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteModel",
"operationName" : "DeleteModel",
"returnType" : {
"returnType" : "DeleteModelResult",
"documentation" : null
},
"syncReturnType" : "DeleteModelResult"
},
"DeleteResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Resource resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteResourceRequest",
"variableName" : "deleteResourceRequest",
"variableType" : "DeleteResourceRequest",
"documentation" : "Request to delete a Resource.
",
"simpleType" : "DeleteResourceRequest",
"variableSetterType" : "DeleteResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteResource",
"operationName" : "DeleteResource",
"returnType" : {
"returnType" : "DeleteResourceResult",
"documentation" : null
},
"syncReturnType" : "DeleteResourceResult"
},
"DeleteRestApi" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteRestApiResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the specified API.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteRestApiRequest",
"variableName" : "deleteRestApiRequest",
"variableType" : "DeleteRestApiRequest",
"documentation" : "Request to delete the specified API from your collection.
",
"simpleType" : "DeleteRestApiRequest",
"variableSetterType" : "DeleteRestApiRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteRestApi",
"operationName" : "DeleteRestApi",
"returnType" : {
"returnType" : "DeleteRestApiResult",
"documentation" : null
},
"syncReturnType" : "DeleteRestApiResult"
},
"DeleteStage" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteStageResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Stage resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteStageRequest",
"variableName" : "deleteStageRequest",
"variableType" : "DeleteStageRequest",
"documentation" : "Requests Amazon API Gateway to delete a Stage resource.
",
"simpleType" : "DeleteStageRequest",
"variableSetterType" : "DeleteStageRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteStage",
"operationName" : "DeleteStage",
"returnType" : {
"returnType" : "DeleteStageResult",
"documentation" : null
},
"syncReturnType" : "DeleteStageResult"
},
"DeleteUsagePlan" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUsagePlanResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a usage plan of a given plan Id.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUsagePlanRequest",
"variableName" : "deleteUsagePlanRequest",
"variableType" : "DeleteUsagePlanRequest",
"documentation" : "The DELETE request to delete a uasge plan of a given plan Id.
",
"simpleType" : "DeleteUsagePlanRequest",
"variableSetterType" : "DeleteUsagePlanRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUsagePlan",
"operationName" : "DeleteUsagePlan",
"returnType" : {
"returnType" : "DeleteUsagePlanResult",
"documentation" : null
},
"syncReturnType" : "DeleteUsagePlanResult"
},
"DeleteUsagePlanKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUsagePlanKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a usage plan key and remove the underlying API key from the associated usage plan.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUsagePlanKeyRequest",
"variableName" : "deleteUsagePlanKeyRequest",
"variableType" : "DeleteUsagePlanKeyRequest",
"documentation" : "The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.
",
"simpleType" : "DeleteUsagePlanKeyRequest",
"variableSetterType" : "DeleteUsagePlanKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUsagePlanKey",
"operationName" : "DeleteUsagePlanKey",
"returnType" : {
"returnType" : "DeleteUsagePlanKeyResult",
"documentation" : null
},
"syncReturnType" : "DeleteUsagePlanKeyResult"
},
"FlushStageAuthorizersCache" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "FlushStageAuthorizersCacheResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Flushes all authorizer cache entries on a stage.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "FlushStageAuthorizersCacheRequest",
"variableName" : "flushStageAuthorizersCacheRequest",
"variableType" : "FlushStageAuthorizersCacheRequest",
"documentation" : "Request to flush authorizer cache entries on a specified stage.
",
"simpleType" : "FlushStageAuthorizersCacheRequest",
"variableSetterType" : "FlushStageAuthorizersCacheRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "flushStageAuthorizersCache",
"operationName" : "FlushStageAuthorizersCache",
"returnType" : {
"returnType" : "FlushStageAuthorizersCacheResult",
"documentation" : null
},
"syncReturnType" : "FlushStageAuthorizersCacheResult"
},
"FlushStageCache" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "FlushStageCacheResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Flushes a stage's cache.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "FlushStageCacheRequest",
"variableName" : "flushStageCacheRequest",
"variableType" : "FlushStageCacheRequest",
"documentation" : "Requests Amazon API Gateway to flush a stage's cache.
",
"simpleType" : "FlushStageCacheRequest",
"variableSetterType" : "FlushStageCacheRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "flushStageCache",
"operationName" : "FlushStageCache",
"returnType" : {
"returnType" : "FlushStageCacheResult",
"documentation" : null
},
"syncReturnType" : "FlushStageCacheResult"
},
"GenerateClientCertificate" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GenerateClientCertificateResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a ClientCertificate resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateClientCertificateRequest",
"variableName" : "generateClientCertificateRequest",
"variableType" : "GenerateClientCertificateRequest",
"documentation" : "A request to generate a ClientCertificate resource.
",
"simpleType" : "GenerateClientCertificateRequest",
"variableSetterType" : "GenerateClientCertificateRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "generateClientCertificate",
"operationName" : "GenerateClientCertificate",
"returnType" : {
"returnType" : "GenerateClientCertificateResult",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer. "
},
"syncReturnType" : "GenerateClientCertificateResult"
},
"GetAccount" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetAccountResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current Account resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAccountRequest",
"variableName" : "getAccountRequest",
"variableType" : "GetAccountRequest",
"documentation" : "Requests Amazon API Gateway to get information about the current Account resource.
",
"simpleType" : "GetAccountRequest",
"variableSetterType" : "GetAccountRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getAccount",
"operationName" : "GetAccount",
"returnType" : {
"returnType" : "GetAccountResult",
"documentation" : "Represents an AWS account that is associated with Amazon 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.
"
},
"syncReturnType" : "GetAccountResult"
},
"GetApiKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetApiKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ApiKey resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetApiKeyRequest",
"variableName" : "getApiKeyRequest",
"variableType" : "GetApiKeyRequest",
"documentation" : "A request to get information about the current ApiKey resource.
",
"simpleType" : "GetApiKeyRequest",
"variableSetterType" : "GetApiKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getApiKey",
"operationName" : "GetApiKey",
"returnType" : {
"returnType" : "GetApiKeyResult",
"documentation" : "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.
"
},
"syncReturnType" : "GetApiKeyResult"
},
"GetApiKeys" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetApiKeysResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ApiKeys resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetApiKeysRequest",
"variableName" : "getApiKeysRequest",
"variableType" : "GetApiKeysRequest",
"documentation" : "A request to get information about the current ApiKeys resource.
",
"simpleType" : "GetApiKeysRequest",
"variableSetterType" : "GetApiKeysRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getApiKeys",
"operationName" : "GetApiKeys",
"returnType" : {
"returnType" : "GetApiKeysResult",
"documentation" : "Represents a collection of API keys as represented by an ApiKeys resource.
"
},
"syncReturnType" : "GetApiKeysResult"
},
"GetAuthorizer" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetAuthorizerResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Authorizer resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAuthorizerRequest",
"variableName" : "getAuthorizerRequest",
"variableType" : "GetAuthorizerRequest",
"documentation" : "Request to describe an existing Authorizer resource.
",
"simpleType" : "GetAuthorizerRequest",
"variableSetterType" : "GetAuthorizerRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getAuthorizer",
"operationName" : "GetAuthorizer",
"returnType" : {
"returnType" : "GetAuthorizerResult",
"documentation" : "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
"
},
"syncReturnType" : "GetAuthorizerResult"
},
"GetAuthorizers" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetAuthorizersResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Authorizers resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAuthorizersRequest",
"variableName" : "getAuthorizersRequest",
"variableType" : "GetAuthorizersRequest",
"documentation" : "Request to describe an existing Authorizers resource.
",
"simpleType" : "GetAuthorizersRequest",
"variableSetterType" : "GetAuthorizersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getAuthorizers",
"operationName" : "GetAuthorizers",
"returnType" : {
"returnType" : "GetAuthorizersResult",
"documentation" : "Represents a collection of Authorizer resources.
"
},
"syncReturnType" : "GetAuthorizersResult"
},
"GetBasePathMapping" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetBasePathMappingResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe a BasePathMapping resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetBasePathMappingRequest",
"variableName" : "getBasePathMappingRequest",
"variableType" : "GetBasePathMappingRequest",
"documentation" : "Request to describe a BasePathMapping resource.
",
"simpleType" : "GetBasePathMappingRequest",
"variableSetterType" : "GetBasePathMappingRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getBasePathMapping",
"operationName" : "GetBasePathMapping",
"returnType" : {
"returnType" : "GetBasePathMappingResult",
"documentation" : "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. "
},
"syncReturnType" : "GetBasePathMappingResult"
},
"GetBasePathMappings" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetBasePathMappingsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a collection of BasePathMapping resources.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetBasePathMappingsRequest",
"variableName" : "getBasePathMappingsRequest",
"variableType" : "GetBasePathMappingsRequest",
"documentation" : "A request to get information about a collection of BasePathMapping resources.
",
"simpleType" : "GetBasePathMappingsRequest",
"variableSetterType" : "GetBasePathMappingsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getBasePathMappings",
"operationName" : "GetBasePathMappings",
"returnType" : {
"returnType" : "GetBasePathMappingsResult",
"documentation" : "Represents a collection of BasePathMapping resources.
"
},
"syncReturnType" : "GetBasePathMappingsResult"
},
"GetClientCertificate" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetClientCertificateResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ClientCertificate resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetClientCertificateRequest",
"variableName" : "getClientCertificateRequest",
"variableType" : "GetClientCertificateRequest",
"documentation" : "A request to get information about the current ClientCertificate resource.
",
"simpleType" : "GetClientCertificateRequest",
"variableSetterType" : "GetClientCertificateRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getClientCertificate",
"operationName" : "GetClientCertificate",
"returnType" : {
"returnType" : "GetClientCertificateResult",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer. "
},
"syncReturnType" : "GetClientCertificateResult"
},
"GetClientCertificates" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetClientCertificatesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a collection of ClientCertificate resources.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetClientCertificatesRequest",
"variableName" : "getClientCertificatesRequest",
"variableType" : "GetClientCertificatesRequest",
"documentation" : "A request to get information about a collection of ClientCertificate resources.
",
"simpleType" : "GetClientCertificatesRequest",
"variableSetterType" : "GetClientCertificatesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getClientCertificates",
"operationName" : "GetClientCertificates",
"returnType" : {
"returnType" : "GetClientCertificatesResult",
"documentation" : "Represents a collection of ClientCertificate resources.
"
},
"syncReturnType" : "GetClientCertificatesResult"
},
"GetDeployment" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetDeploymentResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Deployment resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDeploymentRequest",
"variableName" : "getDeploymentRequest",
"variableType" : "GetDeploymentRequest",
"documentation" : "Requests Amazon API Gateway to get information about a Deployment resource.
",
"simpleType" : "GetDeploymentRequest",
"variableSetterType" : "GetDeploymentRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getDeployment",
"operationName" : "GetDeployment",
"returnType" : {
"returnType" : "GetDeploymentResult",
"documentation" : "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}). "
},
"syncReturnType" : "GetDeploymentResult"
},
"GetDeployments" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetDeploymentsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Deployments collection.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDeploymentsRequest",
"variableName" : "getDeploymentsRequest",
"variableType" : "GetDeploymentsRequest",
"documentation" : "Requests Amazon API Gateway to get information about a Deployments collection.
",
"simpleType" : "GetDeploymentsRequest",
"variableSetterType" : "GetDeploymentsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getDeployments",
"operationName" : "GetDeployments",
"returnType" : {
"returnType" : "GetDeploymentsResult",
"documentation" : "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. "
},
"syncReturnType" : "GetDeploymentsResult"
},
"GetDomainName" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetDomainNameResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDomainNameRequest",
"variableName" : "getDomainNameRequest",
"variableType" : "GetDomainNameRequest",
"documentation" : "Request to get the name of a DomainName resource.
",
"simpleType" : "GetDomainNameRequest",
"variableSetterType" : "GetDomainNameRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getDomainName",
"operationName" : "GetDomainName",
"returnType" : {
"returnType" : "GetDomainNameResult",
"documentation" : "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
"
},
"syncReturnType" : "GetDomainNameResult"
},
"GetDomainNames" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetDomainNamesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a collection of DomainName resources.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDomainNamesRequest",
"variableName" : "getDomainNamesRequest",
"variableType" : "GetDomainNamesRequest",
"documentation" : "Request to describe a collection of DomainName resources.
",
"simpleType" : "GetDomainNamesRequest",
"variableSetterType" : "GetDomainNamesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getDomainNames",
"operationName" : "GetDomainNames",
"returnType" : {
"returnType" : "GetDomainNamesResult",
"documentation" : "Represents a collection of DomainName resources.
"
},
"syncReturnType" : "GetDomainNamesResult"
},
"GetExport" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetExportResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Exports a deployed version of a RestApi in a specified format.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : true,
"input" : {
"variableDeclarationType" : "GetExportRequest",
"variableName" : "getExportRequest",
"variableType" : "GetExportRequest",
"documentation" : "Request a new export of a RestApi for a particular Stage.
",
"simpleType" : "GetExportRequest",
"variableSetterType" : "GetExportRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getExport",
"operationName" : "GetExport",
"returnType" : {
"returnType" : "GetExportResult",
"documentation" : "The binary blob response to GetExport, which contains the generated SDK.
"
},
"syncReturnType" : "GetExportResult"
},
"GetIntegration" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetIntegrationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a get integration.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetIntegrationRequest",
"variableName" : "getIntegrationRequest",
"variableType" : "GetIntegrationRequest",
"documentation" : "Represents a get integration request.
",
"simpleType" : "GetIntegrationRequest",
"variableSetterType" : "GetIntegrationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getIntegration",
"operationName" : "GetIntegration",
"returnType" : {
"returnType" : "GetIntegrationResult",
"documentation" : "Represents an HTTP, AWS, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "GetIntegrationResult"
},
"GetIntegrationResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetIntegrationResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a get integration response.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetIntegrationResponseRequest",
"variableName" : "getIntegrationResponseRequest",
"variableType" : "GetIntegrationResponseRequest",
"documentation" : "Represents a get integration response request.
",
"simpleType" : "GetIntegrationResponseRequest",
"variableSetterType" : "GetIntegrationResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getIntegrationResponse",
"operationName" : "GetIntegrationResponse",
"returnType" : {
"returnType" : "GetIntegrationResponseResult",
"documentation" : "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.
"
},
"syncReturnType" : "GetIntegrationResponseResult"
},
"GetMethod" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetMethodResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Method resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetMethodRequest",
"variableName" : "getMethodRequest",
"variableType" : "GetMethodRequest",
"documentation" : "Request to describe an existing Method resource.
",
"simpleType" : "GetMethodRequest",
"variableSetterType" : "GetMethodRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getMethod",
"operationName" : "GetMethod",
"returnType" : {
"returnType" : "GetMethodResult",
"documentation" : " 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.
Example: Retrive the GET method on a specified resource
Request
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/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/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": true, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }
In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.
"
},
"syncReturnType" : "GetMethodResult"
},
"GetMethodResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetMethodResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes a MethodResponse resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetMethodResponseRequest",
"variableName" : "getMethodResponseRequest",
"variableType" : "GetMethodResponseRequest",
"documentation" : "Request to describe a MethodResponse resource.
",
"simpleType" : "GetMethodResponseRequest",
"variableSetterType" : "GetMethodResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getMethodResponse",
"operationName" : "GetMethodResponse",
"returnType" : {
"returnType" : "GetMethodResponseResult",
"documentation" : "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.
Example: A MethodResponse instance of an API
Request
The example request retrieves a MethodResponse of the 200 status code.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns 200 OK status and a payload as follows:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" }
"
},
"syncReturnType" : "GetMethodResponseResult"
},
"GetModel" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetModelResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes an existing model defined for a RestApi resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetModelRequest",
"variableName" : "getModelRequest",
"variableType" : "GetModelRequest",
"documentation" : "Request to list information about a model in an existing RestApi resource.
",
"simpleType" : "GetModelRequest",
"variableSetterType" : "GetModelRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getModel",
"operationName" : "GetModel",
"returnType" : {
"returnType" : "GetModelResult",
"documentation" : "Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
"
},
"syncReturnType" : "GetModelResult"
},
"GetModelTemplate" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetModelTemplateResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a sample mapping template that can be used to transform a payload into the structure of a model.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetModelTemplateRequest",
"variableName" : "getModelTemplateRequest",
"variableType" : "GetModelTemplateRequest",
"documentation" : "Request to generate a sample mapping template used to transform the payload.
",
"simpleType" : "GetModelTemplateRequest",
"variableSetterType" : "GetModelTemplateRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getModelTemplate",
"operationName" : "GetModelTemplate",
"returnType" : {
"returnType" : "GetModelTemplateResult",
"documentation" : "Represents a mapping template used to transform a payload.
"
},
"syncReturnType" : "GetModelTemplateResult"
},
"GetModels" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetModelsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes existing Models defined for a RestApi resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetModelsRequest",
"variableName" : "getModelsRequest",
"variableType" : "GetModelsRequest",
"documentation" : "Request to list existing Models defined for a RestApi resource.
",
"simpleType" : "GetModelsRequest",
"variableSetterType" : "GetModelsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getModels",
"operationName" : "GetModels",
"returnType" : {
"returnType" : "GetModelsResult",
"documentation" : "Represents a collection of Model resources.
"
},
"syncReturnType" : "GetModelsResult"
},
"GetResource" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetResourceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists information about a resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetResourceRequest",
"variableName" : "getResourceRequest",
"variableType" : "GetResourceRequest",
"documentation" : "Request to list information about a resource.
",
"simpleType" : "GetResourceRequest",
"variableSetterType" : "GetResourceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getResource",
"operationName" : "GetResource",
"returnType" : {
"returnType" : "GetResourceResult",
"documentation" : "Represents an API resource.
"
},
"syncReturnType" : "GetResourceResult"
},
"GetResources" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetResourcesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists information about a collection of Resource resources.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetResourcesRequest",
"variableName" : "getResourcesRequest",
"variableType" : "GetResourcesRequest",
"documentation" : "Request to list information about a collection of resources.
",
"simpleType" : "GetResourcesRequest",
"variableSetterType" : "GetResourcesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getResources",
"operationName" : "GetResources",
"returnType" : {
"returnType" : "GetResourcesResult",
"documentation" : "Represents a collection of Resource resources.
"
},
"syncReturnType" : "GetResourcesResult"
},
"GetRestApi" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetRestApiResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the RestApi resource in the collection.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetRestApiRequest",
"variableName" : "getRestApiRequest",
"variableType" : "GetRestApiRequest",
"documentation" : "The GET request to list an existing RestApi defined for your collection.
",
"simpleType" : "GetRestApiRequest",
"variableSetterType" : "GetRestApiRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getRestApi",
"operationName" : "GetRestApi",
"returnType" : {
"returnType" : "GetRestApiResult",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "GetRestApiResult"
},
"GetRestApis" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetRestApisResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the RestApis resources for your collection.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetRestApisRequest",
"variableName" : "getRestApisRequest",
"variableType" : "GetRestApisRequest",
"documentation" : "The GET request to list existing RestApis defined for your collection.
",
"simpleType" : "GetRestApisRequest",
"variableSetterType" : "GetRestApisRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getRestApis",
"operationName" : "GetRestApis",
"returnType" : {
"returnType" : "GetRestApisResult",
"documentation" : "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.
"
},
"syncReturnType" : "GetRestApisResult"
},
"GetSdk" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetSdkResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a client SDK for a RestApi and Stage.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : true,
"input" : {
"variableDeclarationType" : "GetSdkRequest",
"variableName" : "getSdkRequest",
"variableType" : "GetSdkRequest",
"documentation" : "Request a new generated client SDK for a RestApi and Stage.
",
"simpleType" : "GetSdkRequest",
"variableSetterType" : "GetSdkRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getSdk",
"operationName" : "GetSdk",
"returnType" : {
"returnType" : "GetSdkResult",
"documentation" : "The binary blob response to GetSdk, which contains the generated SDK.
"
},
"syncReturnType" : "GetSdkResult"
},
"GetStage" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetStageResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Stage resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetStageRequest",
"variableName" : "getStageRequest",
"variableType" : "GetStageRequest",
"documentation" : "Requests Amazon API Gateway to get information about a Stage resource.
",
"simpleType" : "GetStageRequest",
"variableSetterType" : "GetStageRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getStage",
"operationName" : "GetStage",
"returnType" : {
"returnType" : "GetStageResult",
"documentation" : "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
"
},
"syncReturnType" : "GetStageResult"
},
"GetStages" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetStagesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about one or more Stage resources.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetStagesRequest",
"variableName" : "getStagesRequest",
"variableType" : "GetStagesRequest",
"documentation" : "Requests Amazon API Gateway to get information about one or more Stage resources.
",
"simpleType" : "GetStagesRequest",
"variableSetterType" : "GetStagesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getStages",
"operationName" : "GetStages",
"returnType" : {
"returnType" : "GetStagesResult",
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
"
},
"syncReturnType" : "GetStagesResult"
},
"GetUsage" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUsageResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the usage data of a usage plan in a specified time interval.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUsageRequest",
"variableName" : "getUsageRequest",
"variableType" : "GetUsageRequest",
"documentation" : "The GET request to get the usage data of a usage plan in a specified time interval.
",
"simpleType" : "GetUsageRequest",
"variableSetterType" : "GetUsageRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUsage",
"operationName" : "GetUsage",
"returnType" : {
"returnType" : "GetUsageResult",
"documentation" : "Represents the usage data of a usage plan.
"
},
"syncReturnType" : "GetUsageResult"
},
"GetUsagePlan" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUsagePlanResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a usage plan of a given plan identifier.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUsagePlanRequest",
"variableName" : "getUsagePlanRequest",
"variableType" : "GetUsagePlanRequest",
"documentation" : "The GET request to get a usage plan of a given plan identifier.
",
"simpleType" : "GetUsagePlanRequest",
"variableSetterType" : "GetUsagePlanRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUsagePlan",
"operationName" : "GetUsagePlan",
"returnType" : {
"returnType" : "GetUsagePlanResult",
"documentation" : "Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
"
},
"syncReturnType" : "GetUsagePlanResult"
},
"GetUsagePlanKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUsagePlanKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a usage plan key of a given key identifier.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUsagePlanKeyRequest",
"variableName" : "getUsagePlanKeyRequest",
"variableType" : "GetUsagePlanKeyRequest",
"documentation" : "The GET request to get a usage plan key of a given key identifier.
",
"simpleType" : "GetUsagePlanKeyRequest",
"variableSetterType" : "GetUsagePlanKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUsagePlanKey",
"operationName" : "GetUsagePlanKey",
"returnType" : {
"returnType" : "GetUsagePlanKeyResult",
"documentation" : "Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.
\" "
},
"syncReturnType" : "GetUsagePlanKeyResult"
},
"GetUsagePlanKeys" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUsagePlanKeysResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets all the usage plan keys representing the API keys added to a specified usage plan.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUsagePlanKeysRequest",
"variableName" : "getUsagePlanKeysRequest",
"variableType" : "GetUsagePlanKeysRequest",
"documentation" : "The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
",
"simpleType" : "GetUsagePlanKeysRequest",
"variableSetterType" : "GetUsagePlanKeysRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUsagePlanKeys",
"operationName" : "GetUsagePlanKeys",
"returnType" : {
"returnType" : "GetUsagePlanKeysResult",
"documentation" : "Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
"
},
"syncReturnType" : "GetUsagePlanKeysResult"
},
"GetUsagePlans" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUsagePlansResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets all the usage plans of the caller's account.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUsagePlansRequest",
"variableName" : "getUsagePlansRequest",
"variableType" : "GetUsagePlansRequest",
"documentation" : "The GET request to get all the usage plans of the caller's account.
",
"simpleType" : "GetUsagePlansRequest",
"variableSetterType" : "GetUsagePlansRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUsagePlans",
"operationName" : "GetUsagePlans",
"returnType" : {
"returnType" : "GetUsagePlansResult",
"documentation" : "Represents a collection of usage plans for an AWS account.
"
},
"syncReturnType" : "GetUsagePlansResult"
},
"ImportApiKeys" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ImportApiKeysResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Import API keys from an external source, such as a CSV-formatted file.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportApiKeysRequest",
"variableName" : "importApiKeysRequest",
"variableType" : "ImportApiKeysRequest",
"documentation" : "The POST request to import API keys from an external source, such as a CSV-formatted file.
",
"simpleType" : "ImportApiKeysRequest",
"variableSetterType" : "ImportApiKeysRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "importApiKeys",
"operationName" : "ImportApiKeys",
"returnType" : {
"returnType" : "ImportApiKeysResult",
"documentation" : "The identifier of an API key used to reference an API key in a usage plan.
"
},
"syncReturnType" : "ImportApiKeysResult"
},
"ImportRestApi" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ImportRestApiResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportRestApiRequest",
"variableName" : "importRestApiRequest",
"variableType" : "ImportRestApiRequest",
"documentation" : "A POST request to import an API to Amazon API Gateway using an input of an API definition file.
",
"simpleType" : "ImportRestApiRequest",
"variableSetterType" : "ImportRestApiRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "importRestApi",
"operationName" : "ImportRestApi",
"returnType" : {
"returnType" : "ImportRestApiResult",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "ImportRestApiResult"
},
"PutIntegration" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutIntegrationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a put integration.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutIntegrationRequest",
"variableName" : "putIntegrationRequest",
"variableType" : "PutIntegrationRequest",
"documentation" : "Represents a put integration request.
",
"simpleType" : "PutIntegrationRequest",
"variableSetterType" : "PutIntegrationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putIntegration",
"operationName" : "PutIntegration",
"returnType" : {
"returnType" : "PutIntegrationResult",
"documentation" : "Represents an HTTP, AWS, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "PutIntegrationResult"
},
"PutIntegrationResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutIntegrationResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a put integration.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutIntegrationResponseRequest",
"variableName" : "putIntegrationResponseRequest",
"variableType" : "PutIntegrationResponseRequest",
"documentation" : "Represents a put integration response request.
",
"simpleType" : "PutIntegrationResponseRequest",
"variableSetterType" : "PutIntegrationResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putIntegrationResponse",
"operationName" : "PutIntegrationResponse",
"returnType" : {
"returnType" : "PutIntegrationResponseResult",
"documentation" : "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.
"
},
"syncReturnType" : "PutIntegrationResponseResult"
},
"PutMethod" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutMethodResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Add a method to an existing Resource resource.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutMethodRequest",
"variableName" : "putMethodRequest",
"variableType" : "PutMethodRequest",
"documentation" : "Request to add a method to an existing Resource resource.
",
"simpleType" : "PutMethodRequest",
"variableSetterType" : "PutMethodRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putMethod",
"operationName" : "PutMethod",
"returnType" : {
"returnType" : "PutMethodResult",
"documentation" : " 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.
Example: Retrive the GET method on a specified resource
Request
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri).
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/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/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": true, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }
In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.
"
},
"syncReturnType" : "PutMethodResult"
},
"PutMethodResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutMethodResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a MethodResponse to an existing Method resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutMethodResponseRequest",
"variableName" : "putMethodResponseRequest",
"variableType" : "PutMethodResponseRequest",
"documentation" : "Request to add a MethodResponse to an existing Method resource.
",
"simpleType" : "PutMethodResponseRequest",
"variableSetterType" : "PutMethodResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putMethodResponse",
"operationName" : "PutMethodResponse",
"returnType" : {
"returnType" : "PutMethodResponseResult",
"documentation" : "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.
Example: A MethodResponse instance of an API
Request
The example request retrieves a MethodResponse of the 200 status code.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns 200 OK status and a payload as follows:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" }
"
},
"syncReturnType" : "PutMethodResponseResult"
},
"PutRestApi" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "PutRestApiResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "LimitExceededException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutRestApiRequest",
"variableName" : "putRestApiRequest",
"variableType" : "PutRestApiRequest",
"documentation" : "A PUT request to update an existing API, with external API definitions specified as the request body.
",
"simpleType" : "PutRestApiRequest",
"variableSetterType" : "PutRestApiRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "putRestApi",
"operationName" : "PutRestApi",
"returnType" : {
"returnType" : "PutRestApiResult",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "PutRestApiResult"
},
"TestInvokeAuthorizer" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "TestInvokeAuthorizerResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TestInvokeAuthorizerRequest",
"variableName" : "testInvokeAuthorizerRequest",
"variableType" : "TestInvokeAuthorizerRequest",
"documentation" : "Make a request to simulate the execution of an Authorizer.
",
"simpleType" : "TestInvokeAuthorizerRequest",
"variableSetterType" : "TestInvokeAuthorizerRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "testInvokeAuthorizer",
"operationName" : "TestInvokeAuthorizer",
"returnType" : {
"returnType" : "TestInvokeAuthorizerResult",
"documentation" : "Represents the response of the test invoke request for a custom Authorizer
"
},
"syncReturnType" : "TestInvokeAuthorizerResult"
},
"TestInvokeMethod" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "TestInvokeMethodResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
",
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TestInvokeMethodRequest",
"variableName" : "testInvokeMethodRequest",
"variableType" : "TestInvokeMethodRequest",
"documentation" : "Make a request to simulate the execution of a Method.
",
"simpleType" : "TestInvokeMethodRequest",
"variableSetterType" : "TestInvokeMethodRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "testInvokeMethod",
"operationName" : "TestInvokeMethod",
"returnType" : {
"returnType" : "TestInvokeMethodResult",
"documentation" : "Represents the response of the test invoke request in the HTTP method.
"
},
"syncReturnType" : "TestInvokeMethodResult"
},
"UpdateAccount" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateAccountResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the current Account resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAccountRequest",
"variableName" : "updateAccountRequest",
"variableType" : "UpdateAccountRequest",
"documentation" : "Requests Amazon API Gateway to change information about the current Account resource.
",
"simpleType" : "UpdateAccountRequest",
"variableSetterType" : "UpdateAccountRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateAccount",
"operationName" : "UpdateAccount",
"returnType" : {
"returnType" : "UpdateAccountResult",
"documentation" : "Represents an AWS account that is associated with Amazon 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.
"
},
"syncReturnType" : "UpdateAccountResult"
},
"UpdateApiKey" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateApiKeyResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about an ApiKey resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateApiKeyRequest",
"variableName" : "updateApiKeyRequest",
"variableType" : "UpdateApiKeyRequest",
"documentation" : "A request to change information about an ApiKey resource.
",
"simpleType" : "UpdateApiKeyRequest",
"variableSetterType" : "UpdateApiKeyRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateApiKey",
"operationName" : "UpdateApiKey",
"returnType" : {
"returnType" : "UpdateApiKeyResult",
"documentation" : "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.
"
},
"syncReturnType" : "UpdateApiKeyResult"
},
"UpdateAuthorizer" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateAuthorizerResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing Authorizer resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAuthorizerRequest",
"variableName" : "updateAuthorizerRequest",
"variableType" : "UpdateAuthorizerRequest",
"documentation" : "Request to update an existing Authorizer resource.
",
"simpleType" : "UpdateAuthorizerRequest",
"variableSetterType" : "UpdateAuthorizerRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateAuthorizer",
"operationName" : "UpdateAuthorizer",
"returnType" : {
"returnType" : "UpdateAuthorizerResult",
"documentation" : "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
"
},
"syncReturnType" : "UpdateAuthorizerResult"
},
"UpdateBasePathMapping" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateBasePathMappingResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the BasePathMapping resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateBasePathMappingRequest",
"variableName" : "updateBasePathMappingRequest",
"variableType" : "UpdateBasePathMappingRequest",
"documentation" : "A request to change information about the BasePathMapping resource.
",
"simpleType" : "UpdateBasePathMappingRequest",
"variableSetterType" : "UpdateBasePathMappingRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateBasePathMapping",
"operationName" : "UpdateBasePathMapping",
"returnType" : {
"returnType" : "UpdateBasePathMappingResult",
"documentation" : "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. "
},
"syncReturnType" : "UpdateBasePathMappingResult"
},
"UpdateClientCertificate" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateClientCertificateResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about an ClientCertificate resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateClientCertificateRequest",
"variableName" : "updateClientCertificateRequest",
"variableType" : "UpdateClientCertificateRequest",
"documentation" : "A request to change information about an ClientCertificate resource.
",
"simpleType" : "UpdateClientCertificateRequest",
"variableSetterType" : "UpdateClientCertificateRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateClientCertificate",
"operationName" : "UpdateClientCertificate",
"returnType" : {
"returnType" : "UpdateClientCertificateResult",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer. "
},
"syncReturnType" : "UpdateClientCertificateResult"
},
"UpdateDeployment" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateDeploymentResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about a Deployment resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDeploymentRequest",
"variableName" : "updateDeploymentRequest",
"variableType" : "UpdateDeploymentRequest",
"documentation" : "Requests Amazon API Gateway to change information about a Deployment resource.
",
"simpleType" : "UpdateDeploymentRequest",
"variableSetterType" : "UpdateDeploymentRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateDeployment",
"operationName" : "UpdateDeployment",
"returnType" : {
"returnType" : "UpdateDeploymentResult",
"documentation" : "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}). "
},
"syncReturnType" : "UpdateDeploymentResult"
},
"UpdateDomainName" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateDomainNameResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the DomainName resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDomainNameRequest",
"variableName" : "updateDomainNameRequest",
"variableType" : "UpdateDomainNameRequest",
"documentation" : "A request to change information about the DomainName resource.
",
"simpleType" : "UpdateDomainNameRequest",
"variableSetterType" : "UpdateDomainNameRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateDomainName",
"operationName" : "UpdateDomainName",
"returnType" : {
"returnType" : "UpdateDomainNameResult",
"documentation" : "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
"
},
"syncReturnType" : "UpdateDomainNameResult"
},
"UpdateIntegration" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateIntegrationResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents an update integration.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateIntegrationRequest",
"variableName" : "updateIntegrationRequest",
"variableType" : "UpdateIntegrationRequest",
"documentation" : "Represents an update integration request.
",
"simpleType" : "UpdateIntegrationRequest",
"variableSetterType" : "UpdateIntegrationRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateIntegration",
"operationName" : "UpdateIntegration",
"returnType" : {
"returnType" : "UpdateIntegrationResult",
"documentation" : "Represents an HTTP, AWS, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "UpdateIntegrationResult"
},
"UpdateIntegrationResponse" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateIntegrationResponseResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents an update integration response.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateIntegrationResponseRequest",
"variableName" : "updateIntegrationResponseRequest",
"variableType" : "UpdateIntegrationResponseRequest",
"documentation" : "Represents an update integration response request.
",
"simpleType" : "UpdateIntegrationResponseRequest",
"variableSetterType" : "UpdateIntegrationResponseRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateIntegrationResponse",
"operationName" : "UpdateIntegrationResponse",
"returnType" : {
"returnType" : "UpdateIntegrationResponseResult",
"documentation" : "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.
"
},
"syncReturnType" : "UpdateIntegrationResponseResult"
},
"UpdateMethod" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateMethodResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing Method resource.
",
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : null
}, {
"exceptionName" : "NotFoundException",
"documentation" : null
}, {
"exceptionName" : "BadRequestException",
"documentation" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : null
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateMethodRequest",
"variableName" : "updateMethodRequest",
"variableType" : "UpdateMethodRequest",
"documentation" : "Request to update an existing Method resource.
",
"simpleType" : "UpdateMethodRequest",
"variableSetterType" : "UpdateMethodRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateMethod",
"operationName" : "UpdateMethod",
"returnType" : {
"returnType" : "UpdateMethodResult",
"documentation" : " 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.
Example: Retrive the GET method on a specified resource
Request
The following example request retrieves the information about the GET method on an API resource (