models.apigateway-2015-07-09-intermediate.json Maven / Gradle / Ivy
Show all versions of apigateway Show documentation
{
"customizationConfig" : {
"attachPayloadTraitToMember" : { },
"blacklistedSimpleMethods" : [ "updateAccount", "createApiKey", "generateClientCertificate" ],
"calculateCrc32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customErrorCodeFieldName" : null,
"customProtocolFactoryFqcn" : null,
"customResponseMetadata" : null,
"customRetryPolicy" : null,
"customServiceMetadata" : null,
"defaultSimpleMethodTestRegion" : null,
"deprecatedOperations" : [ ],
"deprecatedShapes" : [ ],
"excludeClientCreateMethod" : false,
"modelMarshallerDefaultValueSupplier" : { },
"operationModifiers" : null,
"paginationCustomization" : null,
"renameShapes" : null,
"sdkModeledExceptionBaseClassName" : null,
"sdkRequestBaseClassName" : null,
"sdkResponseBaseClassName" : null,
"serviceSpecificClientConfigClass" : null,
"serviceSpecificHttpConfig" : null,
"shapeModifiers" : null,
"shapeSubstitutions" : {
"CacheClusterSize" : {
"emitAsShape" : "String",
"emitFromMember" : null,
"skipMarshallPathForShapes" : null
}
},
"shareModelConfig" : null,
"skipSyncClientGeneration" : false,
"useAutoConstructList" : true,
"useAutoConstructMap" : true,
"utilitiesMethod" : null,
"verifiedSimpleMethods" : [ "getAccount", "getApiKeys", "getClientCertificates", "getDomainNames", "getRestApis", "getSdkTypes", "getUsagePlans", "getVpcLinks", "createApiKey", "generateClientCertificate" ]
},
"metadata" : {
"apiVersion" : "2015-07-09",
"asyncBuilder" : "DefaultApiGatewayAsyncClientBuilder",
"asyncBuilderInterface" : "ApiGatewayAsyncClientBuilder",
"asyncClient" : "DefaultApiGatewayAsyncClient",
"asyncInterface" : "ApiGatewayAsyncClient",
"authPolicyPackageName" : null,
"authType" : "V4",
"baseBuilder" : "DefaultApiGatewayBaseClientBuilder",
"baseBuilderInterface" : "ApiGatewayBaseClientBuilder",
"baseExceptionName" : "ApiGatewayException",
"baseRequestName" : "ApiGatewayRequest",
"baseResponseName" : "ApiGatewayResponse",
"cborProtocol" : false,
"clientPackageName" : "apigateway",
"contentType" : null,
"defaultEndpoint" : null,
"defaultEndpointWithoutHttpProtocol" : null,
"defaultRegion" : null,
"descriptiveServiceName" : "Amazon API Gateway",
"documentation" : "Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
",
"endpointPrefix" : "apigateway",
"fullAuthPolicyPackageName" : "software.amazon.awssdk.services",
"fullClientPackageName" : "software.amazon.awssdk.services.apigateway",
"fullModelPackageName" : "software.amazon.awssdk.services.apigateway.model",
"fullPaginatorsPackageName" : "software.amazon.awssdk.services.apigateway.paginators",
"fullRequestTransformPackageName" : "software.amazon.awssdk.services.apigateway.transform",
"fullTransformPackageName" : "software.amazon.awssdk.services.apigateway.transform",
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"modelPackageName" : "apigateway.model",
"paginatorsPackageName" : "apigateway.paginators",
"protocol" : "rest-json",
"requestTransformPackageName" : "apigateway.transform",
"requiresApiKey" : false,
"requiresIamSigners" : false,
"rootPackageName" : "software.amazon.awssdk.services",
"serviceId" : "API Gateway",
"serviceName" : "ApiGateway",
"signingName" : "apigateway",
"syncBuilder" : "DefaultApiGatewayClientBuilder",
"syncBuilderInterface" : "ApiGatewayClientBuilder",
"syncClient" : "DefaultApiGatewayClient",
"syncInterface" : "ApiGatewayClient",
"transformPackageName" : "apigateway.transform",
"uid" : "apigateway-2015-07-09",
"xmlProtocol" : false
},
"operations" : {
"CreateApiKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Create an ApiKey resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateApiKeyRequest",
"variableName" : "createApiKeyRequest",
"variableType" : "CreateApiKeyRequest",
"documentation" : "Request to create an ApiKey resource.
",
"simpleType" : "CreateApiKeyRequest",
"variableSetterType" : "CreateApiKeyRequest"
},
"methodName" : "createApiKey",
"operationName" : "CreateApiKey",
"paginated" : false,
"returnType" : {
"returnType" : "CreateApiKeyResponse",
"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" : "CreateApiKeyResponse"
},
"CreateAuthorizer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a new Authorizer resource to an existing RestApi resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "createAuthorizer",
"operationName" : "CreateAuthorizer",
"paginated" : false,
"returnType" : {
"returnType" : "CreateAuthorizerResponse",
"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" : "CreateAuthorizerResponse"
},
"CreateBasePathMapping" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new BasePathMapping resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateBasePathMappingRequest",
"variableName" : "createBasePathMappingRequest",
"variableType" : "CreateBasePathMappingRequest",
"documentation" : "Requests API Gateway to create a new BasePathMapping resource.
",
"simpleType" : "CreateBasePathMappingRequest",
"variableSetterType" : "CreateBasePathMappingRequest"
},
"methodName" : "createBasePathMapping",
"operationName" : "CreateBasePathMapping",
"paginated" : false,
"returnType" : {
"returnType" : "CreateBasePathMappingResponse",
"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" : "CreateBasePathMappingResponse"
},
"CreateDeployment" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a Deployment resource, which makes a specified RestApi callable over the internet.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
",
"httpStatusCode" : 503
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDeploymentRequest",
"variableName" : "createDeploymentRequest",
"variableType" : "CreateDeploymentRequest",
"documentation" : "Requests API Gateway to create a Deployment resource.
",
"simpleType" : "CreateDeploymentRequest",
"variableSetterType" : "CreateDeploymentRequest"
},
"methodName" : "createDeployment",
"operationName" : "CreateDeployment",
"paginated" : false,
"returnType" : {
"returnType" : "CreateDeploymentResponse",
"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" : "CreateDeploymentResponse"
},
"CreateDocumentationPart" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDocumentationPartRequest",
"variableName" : "createDocumentationPartRequest",
"variableType" : "CreateDocumentationPartRequest",
"documentation" : "Creates a new documentation part of a given API.
",
"simpleType" : "CreateDocumentationPartRequest",
"variableSetterType" : "CreateDocumentationPartRequest"
},
"methodName" : "createDocumentationPart",
"operationName" : "CreateDocumentationPart",
"paginated" : false,
"returnType" : {
"returnType" : "CreateDocumentationPartResponse",
"documentation" : "A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
"
},
"syncReturnType" : "CreateDocumentationPartResponse"
},
"CreateDocumentationVersion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDocumentationVersionRequest",
"variableName" : "createDocumentationVersionRequest",
"variableType" : "CreateDocumentationVersionRequest",
"documentation" : "Creates a new documentation version of a given API.
",
"simpleType" : "CreateDocumentationVersionRequest",
"variableSetterType" : "CreateDocumentationVersionRequest"
},
"methodName" : "createDocumentationVersion",
"operationName" : "CreateDocumentationVersion",
"paginated" : false,
"returnType" : {
"returnType" : "CreateDocumentationVersionResponse",
"documentation" : "A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
"
},
"syncReturnType" : "CreateDocumentationVersionResponse"
},
"CreateDomainName" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new domain name.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateDomainNameRequest",
"variableName" : "createDomainNameRequest",
"variableType" : "CreateDomainNameRequest",
"documentation" : "A request to create a new domain name.
",
"simpleType" : "CreateDomainNameRequest",
"variableSetterType" : "CreateDomainNameRequest"
},
"methodName" : "createDomainName",
"operationName" : "CreateDomainName",
"paginated" : false,
"returnType" : {
"returnType" : "CreateDomainNameResponse",
"documentation" : "Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
"
},
"syncReturnType" : "CreateDomainNameResponse"
},
"CreateModel" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a new Model resource to an existing RestApi resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "createModel",
"operationName" : "CreateModel",
"paginated" : false,
"returnType" : {
"returnType" : "CreateModelResponse",
"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" : "CreateModelResponse"
},
"CreateRequestValidator" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a ReqeustValidator of a given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateRequestValidatorRequest",
"variableName" : "createRequestValidatorRequest",
"variableType" : "CreateRequestValidatorRequest",
"documentation" : "Creates a RequestValidator of a given RestApi.
",
"simpleType" : "CreateRequestValidatorRequest",
"variableSetterType" : "CreateRequestValidatorRequest"
},
"methodName" : "createRequestValidator",
"operationName" : "CreateRequestValidator",
"paginated" : false,
"returnType" : {
"returnType" : "CreateRequestValidatorResponse",
"documentation" : "A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.
"
},
"syncReturnType" : "CreateRequestValidatorResponse"
},
"CreateResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a Resource resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateResourceRequest",
"variableName" : "createResourceRequest",
"variableType" : "CreateResourceRequest",
"documentation" : "Requests API Gateway to create a Resource resource.
",
"simpleType" : "CreateResourceRequest",
"variableSetterType" : "CreateResourceRequest"
},
"methodName" : "createResource",
"operationName" : "CreateResource",
"paginated" : false,
"returnType" : {
"returnType" : "CreateResourceResponse",
"documentation" : "Represents an API resource.
"
},
"syncReturnType" : "CreateResourceResponse"
},
"CreateRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new RestApi resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "createRestApi",
"operationName" : "CreateRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "CreateRestApiResponse",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "CreateRestApiResponse"
},
"CreateStage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new Stage resource that references a pre-existing Deployment for the API.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateStageRequest",
"variableName" : "createStageRequest",
"variableType" : "CreateStageRequest",
"documentation" : "Requests API Gateway to create a Stage resource.
",
"simpleType" : "CreateStageRequest",
"variableSetterType" : "CreateStageRequest"
},
"methodName" : "createStage",
"operationName" : "CreateStage",
"paginated" : false,
"returnType" : {
"returnType" : "CreateStageResponse",
"documentation" : "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
"
},
"syncReturnType" : "CreateStageResponse"
},
"CreateUsagePlan" : {
"authType" : "IAM",
"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.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"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"
},
"methodName" : "createUsagePlan",
"operationName" : "CreateUsagePlan",
"paginated" : false,
"returnType" : {
"returnType" : "CreateUsagePlanResponse",
"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" : "CreateUsagePlanResponse"
},
"CreateUsagePlanKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a usage plan key for adding an existing API key to a usage plan.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "createUsagePlanKey",
"operationName" : "CreateUsagePlanKey",
"paginated" : false,
"returnType" : {
"returnType" : "CreateUsagePlanKeyResponse",
"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" : "CreateUsagePlanKeyResponse"
},
"CreateVpcLink" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateVpcLinkRequest",
"variableName" : "createVpcLinkRequest",
"variableType" : "CreateVpcLinkRequest",
"documentation" : "Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
",
"simpleType" : "CreateVpcLinkRequest",
"variableSetterType" : "CreateVpcLinkRequest"
},
"methodName" : "createVpcLink",
"operationName" : "CreateVpcLink",
"paginated" : false,
"returnType" : {
"returnType" : "CreateVpcLinkResponse",
"documentation" : "A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
"
},
"syncReturnType" : "CreateVpcLinkResponse"
},
"DeleteApiKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the ApiKey resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteApiKeyRequest",
"variableName" : "deleteApiKeyRequest",
"variableType" : "DeleteApiKeyRequest",
"documentation" : "A request to delete the ApiKey resource.
",
"simpleType" : "DeleteApiKeyRequest",
"variableSetterType" : "DeleteApiKeyRequest"
},
"methodName" : "deleteApiKey",
"operationName" : "DeleteApiKey",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteApiKeyResponse",
"documentation" : null
},
"syncReturnType" : "DeleteApiKeyResponse"
},
"DeleteAuthorizer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing Authorizer resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteAuthorizerRequest",
"variableName" : "deleteAuthorizerRequest",
"variableType" : "DeleteAuthorizerRequest",
"documentation" : "Request to delete an existing Authorizer resource.
",
"simpleType" : "DeleteAuthorizerRequest",
"variableSetterType" : "DeleteAuthorizerRequest"
},
"methodName" : "deleteAuthorizer",
"operationName" : "DeleteAuthorizer",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteAuthorizerResponse",
"documentation" : null
},
"syncReturnType" : "DeleteAuthorizerResponse"
},
"DeleteBasePathMapping" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the BasePathMapping resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteBasePathMappingRequest",
"variableName" : "deleteBasePathMappingRequest",
"variableType" : "DeleteBasePathMappingRequest",
"documentation" : "A request to delete the BasePathMapping resource.
",
"simpleType" : "DeleteBasePathMappingRequest",
"variableSetterType" : "DeleteBasePathMappingRequest"
},
"methodName" : "deleteBasePathMapping",
"operationName" : "DeleteBasePathMapping",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteBasePathMappingResponse",
"documentation" : null
},
"syncReturnType" : "DeleteBasePathMappingResponse"
},
"DeleteClientCertificate" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the ClientCertificate resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteClientCertificateRequest",
"variableName" : "deleteClientCertificateRequest",
"variableType" : "DeleteClientCertificateRequest",
"documentation" : "A request to delete the ClientCertificate resource.
",
"simpleType" : "DeleteClientCertificateRequest",
"variableSetterType" : "DeleteClientCertificateRequest"
},
"methodName" : "deleteClientCertificate",
"operationName" : "DeleteClientCertificate",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteClientCertificateResponse",
"documentation" : null
},
"syncReturnType" : "DeleteClientCertificateResponse"
},
"DeleteDeployment" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDeploymentRequest",
"variableName" : "deleteDeploymentRequest",
"variableType" : "DeleteDeploymentRequest",
"documentation" : "Requests API Gateway to delete a Deployment resource.
",
"simpleType" : "DeleteDeploymentRequest",
"variableSetterType" : "DeleteDeploymentRequest"
},
"methodName" : "deleteDeployment",
"operationName" : "DeleteDeployment",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteDeploymentResponse",
"documentation" : null
},
"syncReturnType" : "DeleteDeploymentResponse"
},
"DeleteDocumentationPart" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDocumentationPartRequest",
"variableName" : "deleteDocumentationPartRequest",
"variableType" : "DeleteDocumentationPartRequest",
"documentation" : "Deletes an existing documentation part of an API.
",
"simpleType" : "DeleteDocumentationPartRequest",
"variableSetterType" : "DeleteDocumentationPartRequest"
},
"methodName" : "deleteDocumentationPart",
"operationName" : "DeleteDocumentationPart",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteDocumentationPartResponse",
"documentation" : null
},
"syncReturnType" : "DeleteDocumentationPartResponse"
},
"DeleteDocumentationVersion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDocumentationVersionRequest",
"variableName" : "deleteDocumentationVersionRequest",
"variableType" : "DeleteDocumentationVersionRequest",
"documentation" : "Deletes an existing documentation version of an API.
",
"simpleType" : "DeleteDocumentationVersionRequest",
"variableSetterType" : "DeleteDocumentationVersionRequest"
},
"methodName" : "deleteDocumentationVersion",
"operationName" : "DeleteDocumentationVersion",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteDocumentationVersionResponse",
"documentation" : null
},
"syncReturnType" : "DeleteDocumentationVersionResponse"
},
"DeleteDomainName" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the DomainName resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteDomainNameRequest",
"variableName" : "deleteDomainNameRequest",
"variableType" : "DeleteDomainNameRequest",
"documentation" : "A request to delete the DomainName resource.
",
"simpleType" : "DeleteDomainNameRequest",
"variableSetterType" : "DeleteDomainNameRequest"
},
"methodName" : "deleteDomainName",
"operationName" : "DeleteDomainName",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteDomainNameResponse",
"documentation" : null
},
"syncReturnType" : "DeleteDomainNameResponse"
},
"DeleteGatewayResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteGatewayResponseRequest",
"variableName" : "deleteGatewayResponseRequest",
"variableType" : "DeleteGatewayResponseRequest",
"documentation" : "Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
",
"simpleType" : "DeleteGatewayResponseRequest",
"variableSetterType" : "DeleteGatewayResponseRequest"
},
"methodName" : "deleteGatewayResponse",
"operationName" : "DeleteGatewayResponse",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteGatewayResponseResponse",
"documentation" : null
},
"syncReturnType" : "DeleteGatewayResponseResponse"
},
"DeleteIntegration" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a delete integration.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteIntegrationRequest",
"variableName" : "deleteIntegrationRequest",
"variableType" : "DeleteIntegrationRequest",
"documentation" : "Represents a delete integration request.
",
"simpleType" : "DeleteIntegrationRequest",
"variableSetterType" : "DeleteIntegrationRequest"
},
"methodName" : "deleteIntegration",
"operationName" : "DeleteIntegration",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteIntegrationResponse",
"documentation" : null
},
"syncReturnType" : "DeleteIntegrationResponse"
},
"DeleteIntegrationResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a delete integration response.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteIntegrationResponseRequest",
"variableName" : "deleteIntegrationResponseRequest",
"variableType" : "DeleteIntegrationResponseRequest",
"documentation" : "Represents a delete integration response request.
",
"simpleType" : "DeleteIntegrationResponseRequest",
"variableSetterType" : "DeleteIntegrationResponseRequest"
},
"methodName" : "deleteIntegrationResponse",
"operationName" : "DeleteIntegrationResponse",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteIntegrationResponseResponse",
"documentation" : null
},
"syncReturnType" : "DeleteIntegrationResponseResponse"
},
"DeleteMethod" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing Method resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteMethodRequest",
"variableName" : "deleteMethodRequest",
"variableType" : "DeleteMethodRequest",
"documentation" : "Request to delete an existing Method resource.
",
"simpleType" : "DeleteMethodRequest",
"variableSetterType" : "DeleteMethodRequest"
},
"methodName" : "deleteMethod",
"operationName" : "DeleteMethod",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteMethodResponse",
"documentation" : null
},
"syncReturnType" : "DeleteMethodResponse"
},
"DeleteMethodResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing MethodResponse resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteMethodResponseRequest",
"variableName" : "deleteMethodResponseRequest",
"variableType" : "DeleteMethodResponseRequest",
"documentation" : "A request to delete an existing MethodResponse resource.
",
"simpleType" : "DeleteMethodResponseRequest",
"variableSetterType" : "DeleteMethodResponseRequest"
},
"methodName" : "deleteMethodResponse",
"operationName" : "DeleteMethodResponse",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteMethodResponseResponse",
"documentation" : null
},
"syncReturnType" : "DeleteMethodResponseResponse"
},
"DeleteModel" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a model.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"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"
},
"methodName" : "deleteModel",
"operationName" : "DeleteModel",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteModelResponse",
"documentation" : null
},
"syncReturnType" : "DeleteModelResponse"
},
"DeleteRequestValidator" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a RequestValidator of a given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteRequestValidatorRequest",
"variableName" : "deleteRequestValidatorRequest",
"variableType" : "DeleteRequestValidatorRequest",
"documentation" : "Deletes a specified RequestValidator of a given RestApi.
",
"simpleType" : "DeleteRequestValidatorRequest",
"variableSetterType" : "DeleteRequestValidatorRequest"
},
"methodName" : "deleteRequestValidator",
"operationName" : "DeleteRequestValidator",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteRequestValidatorResponse",
"documentation" : null
},
"syncReturnType" : "DeleteRequestValidatorResponse"
},
"DeleteResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Resource resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteResourceRequest",
"variableName" : "deleteResourceRequest",
"variableType" : "DeleteResourceRequest",
"documentation" : "Request to delete a Resource.
",
"simpleType" : "DeleteResourceRequest",
"variableSetterType" : "DeleteResourceRequest"
},
"methodName" : "deleteResource",
"operationName" : "DeleteResource",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteResourceResponse",
"documentation" : null
},
"syncReturnType" : "DeleteResourceResponse"
},
"DeleteRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the specified API.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteRestApiRequest",
"variableName" : "deleteRestApiRequest",
"variableType" : "DeleteRestApiRequest",
"documentation" : "Request to delete the specified API from your collection.
",
"simpleType" : "DeleteRestApiRequest",
"variableSetterType" : "DeleteRestApiRequest"
},
"methodName" : "deleteRestApi",
"operationName" : "DeleteRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteRestApiResponse",
"documentation" : null
},
"syncReturnType" : "DeleteRestApiResponse"
},
"DeleteStage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a Stage resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteStageRequest",
"variableName" : "deleteStageRequest",
"variableType" : "DeleteStageRequest",
"documentation" : "Requests API Gateway to delete a Stage resource.
",
"simpleType" : "DeleteStageRequest",
"variableSetterType" : "DeleteStageRequest"
},
"methodName" : "deleteStage",
"operationName" : "DeleteStage",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteStageResponse",
"documentation" : null
},
"syncReturnType" : "DeleteStageResponse"
},
"DeleteUsagePlan" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a usage plan of a given plan Id.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUsagePlanRequest",
"variableName" : "deleteUsagePlanRequest",
"variableType" : "DeleteUsagePlanRequest",
"documentation" : "The DELETE request to delete a usage plan of a given plan Id.
",
"simpleType" : "DeleteUsagePlanRequest",
"variableSetterType" : "DeleteUsagePlanRequest"
},
"methodName" : "deleteUsagePlan",
"operationName" : "DeleteUsagePlan",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteUsagePlanResponse",
"documentation" : null
},
"syncReturnType" : "DeleteUsagePlanResponse"
},
"DeleteUsagePlanKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a usage plan key and remove the underlying API key from the associated usage plan.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "deleteUsagePlanKey",
"operationName" : "DeleteUsagePlanKey",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteUsagePlanKeyResponse",
"documentation" : null
},
"syncReturnType" : "DeleteUsagePlanKeyResponse"
},
"DeleteVpcLink" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes an existing VpcLink of a specified identifier.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteVpcLinkRequest",
"variableName" : "deleteVpcLinkRequest",
"variableType" : "DeleteVpcLinkRequest",
"documentation" : "Deletes an existing VpcLink of a specified identifier.
",
"simpleType" : "DeleteVpcLinkRequest",
"variableSetterType" : "DeleteVpcLinkRequest"
},
"methodName" : "deleteVpcLink",
"operationName" : "DeleteVpcLink",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteVpcLinkResponse",
"documentation" : null
},
"syncReturnType" : "DeleteVpcLinkResponse"
},
"FlushStageAuthorizersCache" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Flushes all authorizer cache entries on a stage.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "FlushStageAuthorizersCacheRequest",
"variableName" : "flushStageAuthorizersCacheRequest",
"variableType" : "FlushStageAuthorizersCacheRequest",
"documentation" : "Request to flush authorizer cache entries on a specified stage.
",
"simpleType" : "FlushStageAuthorizersCacheRequest",
"variableSetterType" : "FlushStageAuthorizersCacheRequest"
},
"methodName" : "flushStageAuthorizersCache",
"operationName" : "FlushStageAuthorizersCache",
"paginated" : false,
"returnType" : {
"returnType" : "FlushStageAuthorizersCacheResponse",
"documentation" : null
},
"syncReturnType" : "FlushStageAuthorizersCacheResponse"
},
"FlushStageCache" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Flushes a stage's cache.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "FlushStageCacheRequest",
"variableName" : "flushStageCacheRequest",
"variableType" : "FlushStageCacheRequest",
"documentation" : "Requests API Gateway to flush a stage's cache.
",
"simpleType" : "FlushStageCacheRequest",
"variableSetterType" : "FlushStageCacheRequest"
},
"methodName" : "flushStageCache",
"operationName" : "FlushStageCache",
"paginated" : false,
"returnType" : {
"returnType" : "FlushStageCacheResponse",
"documentation" : null
},
"syncReturnType" : "FlushStageCacheResponse"
},
"GenerateClientCertificate" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a ClientCertificate resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GenerateClientCertificateRequest",
"variableName" : "generateClientCertificateRequest",
"variableType" : "GenerateClientCertificateRequest",
"documentation" : "A request to generate a ClientCertificate resource.
",
"simpleType" : "GenerateClientCertificateRequest",
"variableSetterType" : "GenerateClientCertificateRequest"
},
"methodName" : "generateClientCertificate",
"operationName" : "GenerateClientCertificate",
"paginated" : false,
"returnType" : {
"returnType" : "GenerateClientCertificateResponse",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool. "
},
"syncReturnType" : "GenerateClientCertificateResponse"
},
"GetAccount" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current Account resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAccountRequest",
"variableName" : "getAccountRequest",
"variableType" : "GetAccountRequest",
"documentation" : "Requests API Gateway to get information about the current Account resource.
",
"simpleType" : "GetAccountRequest",
"variableSetterType" : "GetAccountRequest"
},
"methodName" : "getAccount",
"operationName" : "GetAccount",
"paginated" : false,
"returnType" : {
"returnType" : "GetAccountResponse",
"documentation" : "Represents an AWS account that is associated with API Gateway.
To view the account info, call GET on this resource.
Error Codes
The following exception may be thrown when the request fails.
- UnauthorizedException
- NotFoundException
- TooManyRequestsException
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
Example: Get the information about an account.
Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"https://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" : "GetAccountResponse"
},
"GetApiKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ApiKey resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetApiKeyRequest",
"variableName" : "getApiKeyRequest",
"variableType" : "GetApiKeyRequest",
"documentation" : "A request to get information about the current ApiKey resource.
",
"simpleType" : "GetApiKeyRequest",
"variableSetterType" : "GetApiKeyRequest"
},
"methodName" : "getApiKey",
"operationName" : "GetApiKey",
"paginated" : false,
"returnType" : {
"returnType" : "GetApiKeyResponse",
"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" : "GetApiKeyResponse"
},
"GetApiKeys" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ApiKeys resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetApiKeysRequest",
"variableName" : "getApiKeysRequest",
"variableType" : "GetApiKeysRequest",
"documentation" : "A request to get information about the current ApiKeys resource.
",
"simpleType" : "GetApiKeysRequest",
"variableSetterType" : "GetApiKeysRequest"
},
"methodName" : "getApiKeys",
"operationName" : "GetApiKeys",
"paginated" : true,
"returnType" : {
"returnType" : "GetApiKeysResponse",
"documentation" : "Represents a collection of API keys as represented by an ApiKeys resource.
"
},
"syncReturnType" : "GetApiKeysResponse"
},
"GetAuthorizer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Authorizer resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAuthorizerRequest",
"variableName" : "getAuthorizerRequest",
"variableType" : "GetAuthorizerRequest",
"documentation" : "Request to describe an existing Authorizer resource.
",
"simpleType" : "GetAuthorizerRequest",
"variableSetterType" : "GetAuthorizerRequest"
},
"methodName" : "getAuthorizer",
"operationName" : "GetAuthorizer",
"paginated" : false,
"returnType" : {
"returnType" : "GetAuthorizerResponse",
"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" : "GetAuthorizerResponse"
},
"GetAuthorizers" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Authorizers resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetAuthorizersRequest",
"variableName" : "getAuthorizersRequest",
"variableType" : "GetAuthorizersRequest",
"documentation" : "Request to describe an existing Authorizers resource.
",
"simpleType" : "GetAuthorizersRequest",
"variableSetterType" : "GetAuthorizersRequest"
},
"methodName" : "getAuthorizers",
"operationName" : "GetAuthorizers",
"paginated" : false,
"returnType" : {
"returnType" : "GetAuthorizersResponse",
"documentation" : "Represents a collection of Authorizer resources.
"
},
"syncReturnType" : "GetAuthorizersResponse"
},
"GetBasePathMapping" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe a BasePathMapping resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetBasePathMappingRequest",
"variableName" : "getBasePathMappingRequest",
"variableType" : "GetBasePathMappingRequest",
"documentation" : "Request to describe a BasePathMapping resource.
",
"simpleType" : "GetBasePathMappingRequest",
"variableSetterType" : "GetBasePathMappingRequest"
},
"methodName" : "getBasePathMapping",
"operationName" : "GetBasePathMapping",
"paginated" : false,
"returnType" : {
"returnType" : "GetBasePathMappingResponse",
"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" : "GetBasePathMappingResponse"
},
"GetBasePathMappings" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a collection of BasePathMapping resources.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getBasePathMappings",
"operationName" : "GetBasePathMappings",
"paginated" : true,
"returnType" : {
"returnType" : "GetBasePathMappingsResponse",
"documentation" : "Represents a collection of BasePathMapping resources.
"
},
"syncReturnType" : "GetBasePathMappingsResponse"
},
"GetClientCertificate" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about the current ClientCertificate resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetClientCertificateRequest",
"variableName" : "getClientCertificateRequest",
"variableType" : "GetClientCertificateRequest",
"documentation" : "A request to get information about the current ClientCertificate resource.
",
"simpleType" : "GetClientCertificateRequest",
"variableSetterType" : "GetClientCertificateRequest"
},
"methodName" : "getClientCertificate",
"operationName" : "GetClientCertificate",
"paginated" : false,
"returnType" : {
"returnType" : "GetClientCertificateResponse",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool. "
},
"syncReturnType" : "GetClientCertificateResponse"
},
"GetClientCertificates" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a collection of ClientCertificate resources.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getClientCertificates",
"operationName" : "GetClientCertificates",
"paginated" : true,
"returnType" : {
"returnType" : "GetClientCertificatesResponse",
"documentation" : "Represents a collection of ClientCertificate resources.
"
},
"syncReturnType" : "GetClientCertificatesResponse"
},
"GetDeployment" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Deployment resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
",
"httpStatusCode" : 503
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDeploymentRequest",
"variableName" : "getDeploymentRequest",
"variableType" : "GetDeploymentRequest",
"documentation" : "Requests API Gateway to get information about a Deployment resource.
",
"simpleType" : "GetDeploymentRequest",
"variableSetterType" : "GetDeploymentRequest"
},
"methodName" : "getDeployment",
"operationName" : "GetDeployment",
"paginated" : false,
"returnType" : {
"returnType" : "GetDeploymentResponse",
"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" : "GetDeploymentResponse"
},
"GetDeployments" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Deployments collection.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
",
"httpStatusCode" : 503
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDeploymentsRequest",
"variableName" : "getDeploymentsRequest",
"variableType" : "GetDeploymentsRequest",
"documentation" : "Requests API Gateway to get information about a Deployments collection.
",
"simpleType" : "GetDeploymentsRequest",
"variableSetterType" : "GetDeploymentsRequest"
},
"methodName" : "getDeployments",
"operationName" : "GetDeployments",
"paginated" : true,
"returnType" : {
"returnType" : "GetDeploymentsResponse",
"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" : "GetDeploymentsResponse"
},
"GetDocumentationPart" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDocumentationPartRequest",
"variableName" : "getDocumentationPartRequest",
"variableType" : "GetDocumentationPartRequest",
"documentation" : "Gets a specified documentation part of a given API.
",
"simpleType" : "GetDocumentationPartRequest",
"variableSetterType" : "GetDocumentationPartRequest"
},
"methodName" : "getDocumentationPart",
"operationName" : "GetDocumentationPart",
"paginated" : false,
"returnType" : {
"returnType" : "GetDocumentationPartResponse",
"documentation" : "A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
"
},
"syncReturnType" : "GetDocumentationPartResponse"
},
"GetDocumentationParts" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDocumentationPartsRequest",
"variableName" : "getDocumentationPartsRequest",
"variableType" : "GetDocumentationPartsRequest",
"documentation" : "Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
",
"simpleType" : "GetDocumentationPartsRequest",
"variableSetterType" : "GetDocumentationPartsRequest"
},
"methodName" : "getDocumentationParts",
"operationName" : "GetDocumentationParts",
"paginated" : false,
"returnType" : {
"returnType" : "GetDocumentationPartsResponse",
"documentation" : "The collection of documentation parts of an API.
"
},
"syncReturnType" : "GetDocumentationPartsResponse"
},
"GetDocumentationVersion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDocumentationVersionRequest",
"variableName" : "getDocumentationVersionRequest",
"variableType" : "GetDocumentationVersionRequest",
"documentation" : "Gets a documentation snapshot of an API.
",
"simpleType" : "GetDocumentationVersionRequest",
"variableSetterType" : "GetDocumentationVersionRequest"
},
"methodName" : "getDocumentationVersion",
"operationName" : "GetDocumentationVersion",
"paginated" : false,
"returnType" : {
"returnType" : "GetDocumentationVersionResponse",
"documentation" : "A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
"
},
"syncReturnType" : "GetDocumentationVersionResponse"
},
"GetDocumentationVersions" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDocumentationVersionsRequest",
"variableName" : "getDocumentationVersionsRequest",
"variableType" : "GetDocumentationVersionsRequest",
"documentation" : "Gets the documentation versions of an API.
",
"simpleType" : "GetDocumentationVersionsRequest",
"variableSetterType" : "GetDocumentationVersionsRequest"
},
"methodName" : "getDocumentationVersions",
"operationName" : "GetDocumentationVersions",
"paginated" : false,
"returnType" : {
"returnType" : "GetDocumentationVersionsResponse",
"documentation" : "The collection of documentation snapshots of an API.
Use the DocumentationVersions to manage documentation snapshots associated with various API stages.
"
},
"syncReturnType" : "GetDocumentationVersionsResponse"
},
"GetDomainName" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
",
"httpStatusCode" : 503
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDomainNameRequest",
"variableName" : "getDomainNameRequest",
"variableType" : "GetDomainNameRequest",
"documentation" : "Request to get the name of a DomainName resource.
",
"simpleType" : "GetDomainNameRequest",
"variableSetterType" : "GetDomainNameRequest"
},
"methodName" : "getDomainName",
"operationName" : "GetDomainName",
"paginated" : false,
"returnType" : {
"returnType" : "GetDomainNameResponse",
"documentation" : "Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
"
},
"syncReturnType" : "GetDomainNameResponse"
},
"GetDomainNames" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a collection of DomainName resources.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDomainNamesRequest",
"variableName" : "getDomainNamesRequest",
"variableType" : "GetDomainNamesRequest",
"documentation" : "Request to describe a collection of DomainName resources.
",
"simpleType" : "GetDomainNamesRequest",
"variableSetterType" : "GetDomainNamesRequest"
},
"methodName" : "getDomainNames",
"operationName" : "GetDomainNames",
"paginated" : true,
"returnType" : {
"returnType" : "GetDomainNamesResponse",
"documentation" : "Represents a collection of DomainName resources.
"
},
"syncReturnType" : "GetDomainNamesResponse"
},
"GetExport" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Exports a deployed version of a RestApi in a specified format.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getExport",
"operationName" : "GetExport",
"paginated" : false,
"returnType" : {
"returnType" : "GetExportResponse",
"documentation" : "The binary blob response to GetExport, which contains the generated SDK.
"
},
"syncReturnType" : "GetExportResponse"
},
"GetGatewayResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a GatewayResponse of a specified response type on the given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetGatewayResponseRequest",
"variableName" : "getGatewayResponseRequest",
"variableType" : "GetGatewayResponseRequest",
"documentation" : "Gets a GatewayResponse of a specified response type on the given RestApi.
",
"simpleType" : "GetGatewayResponseRequest",
"variableSetterType" : "GetGatewayResponseRequest"
},
"methodName" : "getGatewayResponse",
"operationName" : "GetGatewayResponse",
"paginated" : false,
"returnType" : {
"returnType" : "GetGatewayResponseResponse",
"documentation" : "A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get a Gateway Response of a given response type
Request
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }
"
},
"syncReturnType" : "GetGatewayResponseResponse"
},
"GetGatewayResponses" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetGatewayResponsesRequest",
"variableName" : "getGatewayResponsesRequest",
"variableType" : "GetGatewayResponsesRequest",
"documentation" : "Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
",
"simpleType" : "GetGatewayResponsesRequest",
"variableSetterType" : "GetGatewayResponsesRequest"
},
"methodName" : "getGatewayResponses",
"operationName" : "GetGatewayResponses",
"paginated" : false,
"returnType" : {
"returnType" : "GetGatewayResponsesResponse",
"documentation" : "The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get the collection of gateway responses of an API
Request
This example request shows how to retrieve the GatewayResponses collection from an API.
GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"first\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"gatewayresponse:by-type\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"item\": [ { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } ] }, \"_embedded\": { \"item\": [ { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_FAILURE\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"RESOURCE_NOT_FOUND\", \"statusCode\": \"404\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"REQUEST_TOO_LARGE\", \"statusCode\": \"413\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"THROTTLED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNSUPPORTED_MEDIA_TYPE\", \"statusCode\": \"415\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_5XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_4XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_PARAMETERS\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_BODY\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"EXPIRED_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"ACCESS_DENIED\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_API_KEY\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNAUTHORIZED\", \"statusCode\": \"401\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"API_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"QUOTA_EXCEEDED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_TIMEOUT\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_SIGNATURE\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_FAILURE\", \"statusCode\": \"500\" } ] } }
"
},
"syncReturnType" : "GetGatewayResponsesResponse"
},
"GetIntegration" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Get the integration settings.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetIntegrationRequest",
"variableName" : "getIntegrationRequest",
"variableType" : "GetIntegrationRequest",
"documentation" : "Represents a request to get the integration configuration.
",
"simpleType" : "GetIntegrationRequest",
"variableSetterType" : "GetIntegrationRequest"
},
"methodName" : "getIntegration",
"operationName" : "GetIntegration",
"paginated" : false,
"returnType" : {
"returnType" : "GetIntegrationResponse",
"documentation" : "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "GetIntegrationResponse"
},
"GetIntegrationResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a get integration response.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetIntegrationResponseRequest",
"variableName" : "getIntegrationResponseRequest",
"variableType" : "GetIntegrationResponseRequest",
"documentation" : "Represents a get integration response request.
",
"simpleType" : "GetIntegrationResponseRequest",
"variableSetterType" : "GetIntegrationResponseRequest"
},
"methodName" : "getIntegrationResponse",
"operationName" : "GetIntegrationResponse",
"paginated" : false,
"returnType" : {
"returnType" : "GetIntegrationResponseResponse",
"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" : "GetIntegrationResponseResponse"
},
"GetMethod" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describe an existing Method resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetMethodRequest",
"variableName" : "getMethodRequest",
"variableType" : "GetMethodRequest",
"documentation" : "Request to describe an existing Method resource.
",
"simpleType" : "GetMethodRequest",
"variableSetterType" : "GetMethodRequest"
},
"methodName" : "getMethod",
"operationName" : "GetMethod",
"paginated" : false,
"returnType" : {
"returnType" : "GetMethodResponse",
"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\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://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" : "GetMethodResponse"
},
"GetMethodResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes a MethodResponse resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetMethodResponseRequest",
"variableName" : "getMethodResponseRequest",
"variableType" : "GetMethodResponseRequest",
"documentation" : "Request to describe a MethodResponse resource.
",
"simpleType" : "GetMethodResponseRequest",
"variableSetterType" : "GetMethodResponseRequest"
},
"methodName" : "getMethodResponse",
"operationName" : "GetMethodResponse",
"paginated" : false,
"returnType" : {
"returnType" : "GetMethodResponseResponse",
"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\": \"https://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" : "GetMethodResponseResponse"
},
"GetModel" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes an existing model defined for a RestApi resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getModel",
"operationName" : "GetModel",
"paginated" : false,
"returnType" : {
"returnType" : "GetModelResponse",
"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" : "GetModelResponse"
},
"GetModelTemplate" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a sample mapping template that can be used to transform a payload into the structure of a model.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getModelTemplate",
"operationName" : "GetModelTemplate",
"paginated" : false,
"returnType" : {
"returnType" : "GetModelTemplateResponse",
"documentation" : "Represents a mapping template used to transform a payload.
"
},
"syncReturnType" : "GetModelTemplateResponse"
},
"GetModels" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes existing Models defined for a RestApi resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetModelsRequest",
"variableName" : "getModelsRequest",
"variableType" : "GetModelsRequest",
"documentation" : "Request to list existing Models defined for a RestApi resource.
",
"simpleType" : "GetModelsRequest",
"variableSetterType" : "GetModelsRequest"
},
"methodName" : "getModels",
"operationName" : "GetModels",
"paginated" : true,
"returnType" : {
"returnType" : "GetModelsResponse",
"documentation" : "Represents a collection of Model resources.
"
},
"syncReturnType" : "GetModelsResponse"
},
"GetRequestValidator" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a RequestValidator of a given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetRequestValidatorRequest",
"variableName" : "getRequestValidatorRequest",
"variableType" : "GetRequestValidatorRequest",
"documentation" : "Gets a RequestValidator of a given RestApi.
",
"simpleType" : "GetRequestValidatorRequest",
"variableSetterType" : "GetRequestValidatorRequest"
},
"methodName" : "getRequestValidator",
"operationName" : "GetRequestValidator",
"paginated" : false,
"returnType" : {
"returnType" : "GetRequestValidatorResponse",
"documentation" : "A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.
"
},
"syncReturnType" : "GetRequestValidatorResponse"
},
"GetRequestValidators" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the RequestValidators collection of a given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetRequestValidatorsRequest",
"variableName" : "getRequestValidatorsRequest",
"variableType" : "GetRequestValidatorsRequest",
"documentation" : "Gets the RequestValidators collection of a given RestApi.
",
"simpleType" : "GetRequestValidatorsRequest",
"variableSetterType" : "GetRequestValidatorsRequest"
},
"methodName" : "getRequestValidators",
"operationName" : "GetRequestValidators",
"paginated" : false,
"returnType" : {
"returnType" : "GetRequestValidatorsResponse",
"documentation" : "A collection of RequestValidator resources of a given RestApi.
In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.
"
},
"syncReturnType" : "GetRequestValidatorsResponse"
},
"GetResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists information about a resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetResourceRequest",
"variableName" : "getResourceRequest",
"variableType" : "GetResourceRequest",
"documentation" : "Request to list information about a resource.
",
"simpleType" : "GetResourceRequest",
"variableSetterType" : "GetResourceRequest"
},
"methodName" : "getResource",
"operationName" : "GetResource",
"paginated" : false,
"returnType" : {
"returnType" : "GetResourceResponse",
"documentation" : "Represents an API resource.
"
},
"syncReturnType" : "GetResourceResponse"
},
"GetResources" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists information about a collection of Resource resources.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetResourcesRequest",
"variableName" : "getResourcesRequest",
"variableType" : "GetResourcesRequest",
"documentation" : "Request to list information about a collection of resources.
",
"simpleType" : "GetResourcesRequest",
"variableSetterType" : "GetResourcesRequest"
},
"methodName" : "getResources",
"operationName" : "GetResources",
"paginated" : true,
"returnType" : {
"returnType" : "GetResourcesResponse",
"documentation" : "Represents a collection of Resource resources.
"
},
"syncReturnType" : "GetResourcesResponse"
},
"GetRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the RestApi resource in the collection.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getRestApi",
"operationName" : "GetRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "GetRestApiResponse",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "GetRestApiResponse"
},
"GetRestApis" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the RestApis resources for your collection.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getRestApis",
"operationName" : "GetRestApis",
"paginated" : true,
"returnType" : {
"returnType" : "GetRestApisResponse",
"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" : "GetRestApisResponse"
},
"GetSdk" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Generates a client SDK for a RestApi and Stage.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getSdk",
"operationName" : "GetSdk",
"paginated" : false,
"returnType" : {
"returnType" : "GetSdkResponse",
"documentation" : "The binary blob response to GetSdk, which contains the generated SDK.
"
},
"syncReturnType" : "GetSdkResponse"
},
"GetSdkType" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetSdkTypeRequest",
"variableName" : "getSdkTypeRequest",
"variableType" : "GetSdkTypeRequest",
"documentation" : "Get an SdkType instance.
",
"simpleType" : "GetSdkTypeRequest",
"variableSetterType" : "GetSdkTypeRequest"
},
"methodName" : "getSdkType",
"operationName" : "GetSdkType",
"paginated" : false,
"returnType" : {
"returnType" : "GetSdkTypeResponse",
"documentation" : "A type of SDK that API Gateway can generate.
"
},
"syncReturnType" : "GetSdkTypeResponse"
},
"GetSdkTypes" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetSdkTypesRequest",
"variableName" : "getSdkTypesRequest",
"variableType" : "GetSdkTypesRequest",
"documentation" : "Get the SdkTypes collection.
",
"simpleType" : "GetSdkTypesRequest",
"variableSetterType" : "GetSdkTypesRequest"
},
"methodName" : "getSdkTypes",
"operationName" : "GetSdkTypes",
"paginated" : false,
"returnType" : {
"returnType" : "GetSdkTypesResponse",
"documentation" : "The collection of SdkType instances.
"
},
"syncReturnType" : "GetSdkTypesResponse"
},
"GetStage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about a Stage resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetStageRequest",
"variableName" : "getStageRequest",
"variableType" : "GetStageRequest",
"documentation" : "Requests API Gateway to get information about a Stage resource.
",
"simpleType" : "GetStageRequest",
"variableSetterType" : "GetStageRequest"
},
"methodName" : "getStage",
"operationName" : "GetStage",
"paginated" : false,
"returnType" : {
"returnType" : "GetStageResponse",
"documentation" : "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
"
},
"syncReturnType" : "GetStageResponse"
},
"GetStages" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets information about one or more Stage resources.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetStagesRequest",
"variableName" : "getStagesRequest",
"variableType" : "GetStagesRequest",
"documentation" : "Requests API Gateway to get information about one or more Stage resources.
",
"simpleType" : "GetStagesRequest",
"variableSetterType" : "GetStagesRequest"
},
"methodName" : "getStages",
"operationName" : "GetStages",
"paginated" : false,
"returnType" : {
"returnType" : "GetStagesResponse",
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
"
},
"syncReturnType" : "GetStagesResponse"
},
"GetTags" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the Tags collection for a given resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetTagsRequest",
"variableName" : "getTagsRequest",
"variableType" : "GetTagsRequest",
"documentation" : "Gets the Tags collection for a given resource.
",
"simpleType" : "GetTagsRequest",
"variableSetterType" : "GetTagsRequest"
},
"methodName" : "getTags",
"operationName" : "GetTags",
"paginated" : false,
"returnType" : {
"returnType" : "GetTagsResponse",
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
"
},
"syncReturnType" : "GetTagsResponse"
},
"GetUsage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the usage data of a usage plan in a specified time interval.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getUsage",
"operationName" : "GetUsage",
"paginated" : true,
"returnType" : {
"returnType" : "GetUsageResponse",
"documentation" : "Represents the usage data of a usage plan.
"
},
"syncReturnType" : "GetUsageResponse"
},
"GetUsagePlan" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a usage plan of a given plan identifier.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getUsagePlan",
"operationName" : "GetUsagePlan",
"paginated" : false,
"returnType" : {
"returnType" : "GetUsagePlanResponse",
"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" : "GetUsagePlanResponse"
},
"GetUsagePlanKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a usage plan key of a given key identifier.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getUsagePlanKey",
"operationName" : "GetUsagePlanKey",
"paginated" : false,
"returnType" : {
"returnType" : "GetUsagePlanKeyResponse",
"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" : "GetUsagePlanKeyResponse"
},
"GetUsagePlanKeys" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets all the usage plan keys representing the API keys added to a specified usage plan.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"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"
},
"methodName" : "getUsagePlanKeys",
"operationName" : "GetUsagePlanKeys",
"paginated" : true,
"returnType" : {
"returnType" : "GetUsagePlanKeysResponse",
"documentation" : "Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
"
},
"syncReturnType" : "GetUsagePlanKeysResponse"
},
"GetUsagePlans" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets all the usage plans of the caller's account.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"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"
},
"methodName" : "getUsagePlans",
"operationName" : "GetUsagePlans",
"paginated" : true,
"returnType" : {
"returnType" : "GetUsagePlansResponse",
"documentation" : "Represents a collection of usage plans for an AWS account.
"
},
"syncReturnType" : "GetUsagePlansResponse"
},
"GetVpcLink" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets a specified VPC link under the caller's account in a region.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetVpcLinkRequest",
"variableName" : "getVpcLinkRequest",
"variableType" : "GetVpcLinkRequest",
"documentation" : "Gets a specified VPC link under the caller's account in a region.
",
"simpleType" : "GetVpcLinkRequest",
"variableSetterType" : "GetVpcLinkRequest"
},
"methodName" : "getVpcLink",
"operationName" : "GetVpcLink",
"paginated" : false,
"returnType" : {
"returnType" : "GetVpcLinkResponse",
"documentation" : "A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
"
},
"syncReturnType" : "GetVpcLinkResponse"
},
"GetVpcLinks" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the VpcLinks collection under the caller's account in a selected region.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetVpcLinksRequest",
"variableName" : "getVpcLinksRequest",
"variableType" : "GetVpcLinksRequest",
"documentation" : "Gets the VpcLinks collection under the caller's account in a selected region.
",
"simpleType" : "GetVpcLinksRequest",
"variableSetterType" : "GetVpcLinksRequest"
},
"methodName" : "getVpcLinks",
"operationName" : "GetVpcLinks",
"paginated" : true,
"returnType" : {
"returnType" : "GetVpcLinksResponse",
"documentation" : "The collection of VPC links under the caller's account in a region.
"
},
"syncReturnType" : "GetVpcLinksResponse"
},
"ImportApiKeys" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Import API keys from an external source, such as a CSV-formatted file.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"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"
},
"methodName" : "importApiKeys",
"operationName" : "ImportApiKeys",
"paginated" : false,
"returnType" : {
"returnType" : "ImportApiKeysResponse",
"documentation" : "The identifier of an ApiKey used in a UsagePlan.
"
},
"syncReturnType" : "ImportApiKeysResponse"
},
"ImportDocumentationParts" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportDocumentationPartsRequest",
"variableName" : "importDocumentationPartsRequest",
"variableType" : "ImportDocumentationPartsRequest",
"documentation" : "Import documentation parts from an external (e.g., OpenAPI) definition file.
",
"simpleType" : "ImportDocumentationPartsRequest",
"variableSetterType" : "ImportDocumentationPartsRequest"
},
"methodName" : "importDocumentationParts",
"operationName" : "ImportDocumentationParts",
"paginated" : false,
"returnType" : {
"returnType" : "ImportDocumentationPartsResponse",
"documentation" : "A collection of the imported DocumentationPart identifiers.
This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway "
},
"syncReturnType" : "ImportDocumentationPartsResponse"
},
"ImportRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "A feature of the API Gateway control service for creating a new API from an external API definition file.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportRestApiRequest",
"variableName" : "importRestApiRequest",
"variableType" : "ImportRestApiRequest",
"documentation" : "A POST request to import an API to API Gateway using an input of an API definition file.
",
"simpleType" : "ImportRestApiRequest",
"variableSetterType" : "ImportRestApiRequest"
},
"methodName" : "importRestApi",
"operationName" : "ImportRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "ImportRestApiResponse",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "ImportRestApiResponse"
},
"PutGatewayResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutGatewayResponseRequest",
"variableName" : "putGatewayResponseRequest",
"variableType" : "PutGatewayResponseRequest",
"documentation" : "Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
",
"simpleType" : "PutGatewayResponseRequest",
"variableSetterType" : "PutGatewayResponseRequest"
},
"methodName" : "putGatewayResponse",
"operationName" : "PutGatewayResponse",
"paginated" : false,
"returnType" : {
"returnType" : "PutGatewayResponseResponse",
"documentation" : "A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get a Gateway Response of a given response type
Request
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }
"
},
"syncReturnType" : "PutGatewayResponseResponse"
},
"PutIntegration" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sets up a method's integration.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutIntegrationRequest",
"variableName" : "putIntegrationRequest",
"variableType" : "PutIntegrationRequest",
"documentation" : "Sets up a method's integration.
",
"simpleType" : "PutIntegrationRequest",
"variableSetterType" : "PutIntegrationRequest"
},
"methodName" : "putIntegration",
"operationName" : "PutIntegration",
"paginated" : false,
"returnType" : {
"returnType" : "PutIntegrationResponse",
"documentation" : "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "PutIntegrationResponse"
},
"PutIntegrationResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents a put integration.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutIntegrationResponseRequest",
"variableName" : "putIntegrationResponseRequest",
"variableType" : "PutIntegrationResponseRequest",
"documentation" : "Represents a put integration response request.
",
"simpleType" : "PutIntegrationResponseRequest",
"variableSetterType" : "PutIntegrationResponseRequest"
},
"methodName" : "putIntegrationResponse",
"operationName" : "PutIntegrationResponse",
"paginated" : false,
"returnType" : {
"returnType" : "PutIntegrationResponseResponse",
"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" : "PutIntegrationResponseResponse"
},
"PutMethod" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Add a method to an existing Resource resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutMethodRequest",
"variableName" : "putMethodRequest",
"variableType" : "PutMethodRequest",
"documentation" : "Request to add a method to an existing Resource resource.
",
"simpleType" : "PutMethodRequest",
"variableSetterType" : "PutMethodRequest"
},
"methodName" : "putMethod",
"operationName" : "PutMethod",
"paginated" : false,
"returnType" : {
"returnType" : "PutMethodResponse",
"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\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://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" : "PutMethodResponse"
},
"PutMethodResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a MethodResponse to an existing Method resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PutMethodResponseRequest",
"variableName" : "putMethodResponseRequest",
"variableType" : "PutMethodResponseRequest",
"documentation" : "Request to add a MethodResponse to an existing Method resource.
",
"simpleType" : "PutMethodResponseRequest",
"variableSetterType" : "PutMethodResponseRequest"
},
"methodName" : "putMethodResponse",
"operationName" : "PutMethodResponse",
"paginated" : false,
"returnType" : {
"returnType" : "PutMethodResponseResponse",
"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\": \"https://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" : "PutMethodResponseResponse"
},
"PutRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "A feature of the 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.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"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"
},
"methodName" : "putRestApi",
"operationName" : "PutRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "PutRestApiResponse",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "PutRestApiResponse"
},
"TagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds or updates a tag on a given resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TagResourceRequest",
"variableName" : "tagResourceRequest",
"variableType" : "TagResourceRequest",
"documentation" : "Adds or updates a tag on a given resource.
",
"simpleType" : "TagResourceRequest",
"variableSetterType" : "TagResourceRequest"
},
"methodName" : "tagResource",
"operationName" : "TagResource",
"paginated" : false,
"returnType" : {
"returnType" : "TagResourceResponse",
"documentation" : null
},
"syncReturnType" : "TagResourceResponse"
},
"TestInvokeAuthorizer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TestInvokeAuthorizerRequest",
"variableName" : "testInvokeAuthorizerRequest",
"variableType" : "TestInvokeAuthorizerRequest",
"documentation" : "Make a request to simulate the execution of an Authorizer.
",
"simpleType" : "TestInvokeAuthorizerRequest",
"variableSetterType" : "TestInvokeAuthorizerRequest"
},
"methodName" : "testInvokeAuthorizer",
"operationName" : "TestInvokeAuthorizer",
"paginated" : false,
"returnType" : {
"returnType" : "TestInvokeAuthorizerResponse",
"documentation" : "Represents the response of the test invoke request for a custom Authorizer
"
},
"syncReturnType" : "TestInvokeAuthorizerResponse"
},
"TestInvokeMethod" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TestInvokeMethodRequest",
"variableName" : "testInvokeMethodRequest",
"variableType" : "TestInvokeMethodRequest",
"documentation" : "Make a request to simulate the execution of a Method.
",
"simpleType" : "TestInvokeMethodRequest",
"variableSetterType" : "TestInvokeMethodRequest"
},
"methodName" : "testInvokeMethod",
"operationName" : "TestInvokeMethod",
"paginated" : false,
"returnType" : {
"returnType" : "TestInvokeMethodResponse",
"documentation" : "Represents the response of the test invoke request in the HTTP method.
"
},
"syncReturnType" : "TestInvokeMethodResponse"
},
"UntagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Removes a tag from a given resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UntagResourceRequest",
"variableName" : "untagResourceRequest",
"variableType" : "UntagResourceRequest",
"documentation" : "Removes a tag from a given resource.
",
"simpleType" : "UntagResourceRequest",
"variableSetterType" : "UntagResourceRequest"
},
"methodName" : "untagResource",
"operationName" : "UntagResource",
"paginated" : false,
"returnType" : {
"returnType" : "UntagResourceResponse",
"documentation" : null
},
"syncReturnType" : "UntagResourceResponse"
},
"UpdateAccount" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the current Account resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAccountRequest",
"variableName" : "updateAccountRequest",
"variableType" : "UpdateAccountRequest",
"documentation" : "Requests API Gateway to change information about the current Account resource.
",
"simpleType" : "UpdateAccountRequest",
"variableSetterType" : "UpdateAccountRequest"
},
"methodName" : "updateAccount",
"operationName" : "UpdateAccount",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateAccountResponse",
"documentation" : "Represents an AWS account that is associated with API Gateway.
To view the account info, call GET on this resource.
Error Codes
The following exception may be thrown when the request fails.
- UnauthorizedException
- NotFoundException
- TooManyRequestsException
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
Example: Get the information about an account.
Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
The successful response returns a 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"https://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" : "UpdateAccountResponse"
},
"UpdateApiKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about an ApiKey resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateApiKeyRequest",
"variableName" : "updateApiKeyRequest",
"variableType" : "UpdateApiKeyRequest",
"documentation" : "A request to change information about an ApiKey resource.
",
"simpleType" : "UpdateApiKeyRequest",
"variableSetterType" : "UpdateApiKeyRequest"
},
"methodName" : "updateApiKey",
"operationName" : "UpdateApiKey",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateApiKeyResponse",
"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" : "UpdateApiKeyResponse"
},
"UpdateAuthorizer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing Authorizer resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateAuthorizerRequest",
"variableName" : "updateAuthorizerRequest",
"variableType" : "UpdateAuthorizerRequest",
"documentation" : "Request to update an existing Authorizer resource.
",
"simpleType" : "UpdateAuthorizerRequest",
"variableSetterType" : "UpdateAuthorizerRequest"
},
"methodName" : "updateAuthorizer",
"operationName" : "UpdateAuthorizer",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateAuthorizerResponse",
"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" : "UpdateAuthorizerResponse"
},
"UpdateBasePathMapping" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the BasePathMapping resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateBasePathMappingRequest",
"variableName" : "updateBasePathMappingRequest",
"variableType" : "UpdateBasePathMappingRequest",
"documentation" : "A request to change information about the BasePathMapping resource.
",
"simpleType" : "UpdateBasePathMappingRequest",
"variableSetterType" : "UpdateBasePathMappingRequest"
},
"methodName" : "updateBasePathMapping",
"operationName" : "UpdateBasePathMapping",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateBasePathMappingResponse",
"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" : "UpdateBasePathMappingResponse"
},
"UpdateClientCertificate" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about an ClientCertificate resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateClientCertificateRequest",
"variableName" : "updateClientCertificateRequest",
"variableType" : "UpdateClientCertificateRequest",
"documentation" : "A request to change information about an ClientCertificate resource.
",
"simpleType" : "UpdateClientCertificateRequest",
"variableSetterType" : "UpdateClientCertificateRequest"
},
"methodName" : "updateClientCertificate",
"operationName" : "UpdateClientCertificate",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateClientCertificateResponse",
"documentation" : "Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool. "
},
"syncReturnType" : "UpdateClientCertificateResponse"
},
"UpdateDeployment" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about a Deployment resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
",
"httpStatusCode" : 503
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDeploymentRequest",
"variableName" : "updateDeploymentRequest",
"variableType" : "UpdateDeploymentRequest",
"documentation" : "Requests API Gateway to change information about a Deployment resource.
",
"simpleType" : "UpdateDeploymentRequest",
"variableSetterType" : "UpdateDeploymentRequest"
},
"methodName" : "updateDeployment",
"operationName" : "UpdateDeployment",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateDeploymentResponse",
"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" : "UpdateDeploymentResponse"
},
"UpdateDocumentationPart" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDocumentationPartRequest",
"variableName" : "updateDocumentationPartRequest",
"variableType" : "UpdateDocumentationPartRequest",
"documentation" : "Updates an existing documentation part of a given API.
",
"simpleType" : "UpdateDocumentationPartRequest",
"variableSetterType" : "UpdateDocumentationPartRequest"
},
"methodName" : "updateDocumentationPart",
"operationName" : "UpdateDocumentationPart",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateDocumentationPartResponse",
"documentation" : "A documentation part for a targeted API entity.
A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.
"
},
"syncReturnType" : "UpdateDocumentationPartResponse"
},
"UpdateDocumentationVersion" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDocumentationVersionRequest",
"variableName" : "updateDocumentationVersionRequest",
"variableType" : "UpdateDocumentationVersionRequest",
"documentation" : "Updates an existing documentation version of an API.
",
"simpleType" : "UpdateDocumentationVersionRequest",
"variableSetterType" : "UpdateDocumentationVersionRequest"
},
"methodName" : "updateDocumentationVersion",
"operationName" : "UpdateDocumentationVersion",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateDocumentationVersionResponse",
"documentation" : "A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.
"
},
"syncReturnType" : "UpdateDocumentationVersionResponse"
},
"UpdateDomainName" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the DomainName resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDomainNameRequest",
"variableName" : "updateDomainNameRequest",
"variableType" : "UpdateDomainNameRequest",
"documentation" : "A request to change information about the DomainName resource.
",
"simpleType" : "UpdateDomainNameRequest",
"variableSetterType" : "UpdateDomainNameRequest"
},
"methodName" : "updateDomainName",
"operationName" : "UpdateDomainName",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateDomainNameResponse",
"documentation" : "Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.
"
},
"syncReturnType" : "UpdateDomainNameResponse"
},
"UpdateGatewayResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates a GatewayResponse of a specified response type on the given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateGatewayResponseRequest",
"variableName" : "updateGatewayResponseRequest",
"variableType" : "UpdateGatewayResponseRequest",
"documentation" : "Updates a GatewayResponse of a specified response type on the given RestApi.
",
"simpleType" : "UpdateGatewayResponseRequest",
"variableSetterType" : "UpdateGatewayResponseRequest"
},
"methodName" : "updateGatewayResponse",
"operationName" : "UpdateGatewayResponse",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateGatewayResponseResponse",
"documentation" : "A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get a Gateway Response of a given response type
Request
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45
The response type is specified as a URL path.
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }
"
},
"syncReturnType" : "UpdateGatewayResponseResponse"
},
"UpdateIntegration" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents an update integration.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateIntegrationRequest",
"variableName" : "updateIntegrationRequest",
"variableType" : "UpdateIntegrationRequest",
"documentation" : "Represents an update integration request.
",
"simpleType" : "UpdateIntegrationRequest",
"variableSetterType" : "UpdateIntegrationRequest"
},
"methodName" : "updateIntegration",
"operationName" : "UpdateIntegration",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateIntegrationResponse",
"documentation" : "Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration. "
},
"syncReturnType" : "UpdateIntegrationResponse"
},
"UpdateIntegrationResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Represents an update integration response.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateIntegrationResponseRequest",
"variableName" : "updateIntegrationResponseRequest",
"variableType" : "UpdateIntegrationResponseRequest",
"documentation" : "Represents an update integration response request.
",
"simpleType" : "UpdateIntegrationResponseRequest",
"variableSetterType" : "UpdateIntegrationResponseRequest"
},
"methodName" : "updateIntegrationResponse",
"operationName" : "UpdateIntegrationResponse",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateIntegrationResponseResponse",
"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" : "UpdateIntegrationResponseResponse"
},
"UpdateMethod" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing Method resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateMethodRequest",
"variableName" : "updateMethodRequest",
"variableType" : "UpdateMethodRequest",
"documentation" : "Request to update an existing Method resource.
",
"simpleType" : "UpdateMethodRequest",
"variableSetterType" : "UpdateMethodRequest"
},
"methodName" : "updateMethod",
"operationName" : "UpdateMethod",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateMethodResponse",
"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\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://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" : "UpdateMethodResponse"
},
"UpdateMethodResponse" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing MethodResponse resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The request exceeded the rate limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateMethodResponseRequest",
"variableName" : "updateMethodResponseRequest",
"variableType" : "UpdateMethodResponseRequest",
"documentation" : "A request to update an existing MethodResponse resource.
",
"simpleType" : "UpdateMethodResponseRequest",
"variableSetterType" : "UpdateMethodResponseRequest"
},
"methodName" : "updateMethodResponse",
"operationName" : "UpdateMethodResponse",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateMethodResponseResponse",
"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\": \"https://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" : "UpdateMethodResponseResponse"
},
"UpdateModel" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about a model.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateModelRequest",
"variableName" : "updateModelRequest",
"variableType" : "UpdateModelRequest",
"documentation" : "Request to update an existing model in an existing RestApi resource.
",
"simpleType" : "UpdateModelRequest",
"variableSetterType" : "UpdateModelRequest"
},
"methodName" : "updateModel",
"operationName" : "UpdateModel",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateModelResponse",
"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" : "UpdateModelResponse"
},
"UpdateRequestValidator" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates a RequestValidator of a given RestApi.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateRequestValidatorRequest",
"variableName" : "updateRequestValidatorRequest",
"variableType" : "UpdateRequestValidatorRequest",
"documentation" : "Updates a RequestValidator of a given RestApi.
",
"simpleType" : "UpdateRequestValidatorRequest",
"variableSetterType" : "UpdateRequestValidatorRequest"
},
"methodName" : "updateRequestValidator",
"operationName" : "UpdateRequestValidator",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateRequestValidatorResponse",
"documentation" : "A set of validation rules for incoming Method requests.
In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.
"
},
"syncReturnType" : "UpdateRequestValidatorResponse"
},
"UpdateResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about a Resource resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateResourceRequest",
"variableName" : "updateResourceRequest",
"variableType" : "UpdateResourceRequest",
"documentation" : "Request to change information about a Resource resource.
",
"simpleType" : "UpdateResourceRequest",
"variableSetterType" : "UpdateResourceRequest"
},
"methodName" : "updateResource",
"operationName" : "UpdateResource",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateResourceResponse",
"documentation" : "Represents an API resource.
"
},
"syncReturnType" : "UpdateResourceResponse"
},
"UpdateRestApi" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about the specified API.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateRestApiRequest",
"variableName" : "updateRestApiRequest",
"variableType" : "UpdateRestApiRequest",
"documentation" : "Request to update an existing RestApi resource in your collection.
",
"simpleType" : "UpdateRestApiRequest",
"variableSetterType" : "UpdateRestApiRequest"
},
"methodName" : "updateRestApi",
"operationName" : "UpdateRestApi",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateRestApiResponse",
"documentation" : "Represents a REST API.
"
},
"syncReturnType" : "UpdateRestApiResponse"
},
"UpdateStage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes information about a Stage resource.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateStageRequest",
"variableName" : "updateStageRequest",
"variableType" : "UpdateStageRequest",
"documentation" : "Requests API Gateway to change information about a Stage resource.
",
"simpleType" : "UpdateStageRequest",
"variableSetterType" : "UpdateStageRequest"
},
"methodName" : "updateStage",
"operationName" : "UpdateStage",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateStageResponse",
"documentation" : "Represents a unique identifier for a version of a deployed RestApi that is callable by users.
"
},
"syncReturnType" : "UpdateStageResponse"
},
"UpdateUsage" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUsageRequest",
"variableName" : "updateUsageRequest",
"variableType" : "UpdateUsageRequest",
"documentation" : "The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.
",
"simpleType" : "UpdateUsageRequest",
"variableSetterType" : "UpdateUsageRequest"
},
"methodName" : "updateUsage",
"operationName" : "UpdateUsage",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateUsageResponse",
"documentation" : "Represents the usage data of a usage plan.
"
},
"syncReturnType" : "UpdateUsageResponse"
},
"UpdateUsagePlan" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates a usage plan of a given plan Id.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUsagePlanRequest",
"variableName" : "updateUsagePlanRequest",
"variableType" : "UpdateUsagePlanRequest",
"documentation" : "The PATCH request to update a usage plan of a given plan Id.
",
"simpleType" : "UpdateUsagePlanRequest",
"variableSetterType" : "UpdateUsagePlanRequest"
},
"methodName" : "updateUsagePlan",
"operationName" : "UpdateUsagePlan",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateUsagePlanResponse",
"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" : "UpdateUsagePlanResponse"
},
"UpdateVpcLink" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates an existing VpcLink of a specified identifier.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "UnauthorizedException",
"documentation" : "The request is denied because the caller has insufficient permissions.
",
"httpStatusCode" : 401
}, {
"exceptionName" : "NotFoundException",
"documentation" : "The requested resource is not found. Make sure that the request URI is correct.
",
"httpStatusCode" : 404
}, {
"exceptionName" : "BadRequestException",
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"httpStatusCode" : 400
}, {
"exceptionName" : "ConflictException",
"documentation" : "The request configuration has conflicts. For details, see the accompanying error message.
",
"httpStatusCode" : 409
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "The request has reached its throttling limit. Retry after the specified time period.
",
"httpStatusCode" : 429
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateVpcLinkRequest",
"variableName" : "updateVpcLinkRequest",
"variableType" : "UpdateVpcLinkRequest",
"documentation" : "Updates an existing VpcLink of a specified identifier.
",
"simpleType" : "UpdateVpcLinkRequest",
"variableSetterType" : "UpdateVpcLinkRequest"
},
"methodName" : "updateVpcLink",
"operationName" : "UpdateVpcLink",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateVpcLinkResponse",
"documentation" : "A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.
"
},
"syncReturnType" : "UpdateVpcLinkResponse"
}
},
"shapes" : {
"AccessLogSettings" : {
"c2jName" : "AccessLogSettings",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Access log settings, including the access log format and access log destination ARN.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getFormat",
"beanStyleSetterMethodName" : "setFormat",
"c2jName" : "format",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #format(String)}.\n@param format a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #format(String)",
"deprecated" : false,
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "format",
"fluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "format",
"getterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@return A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "format",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "format",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Format",
"sensitive" : false,
"setterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"setterMethodName" : "setFormat",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDestinationArn",
"beanStyleSetterMethodName" : "setDestinationArn",
"c2jName" : "destinationArn",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #destinationArn(String)}.\n@param destinationArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #destinationArn(String)",
"deprecated" : false,
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "destinationArn",
"fluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "destinationArn",
"getterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@return The ARN of the CloudWatch Logs log group to receive access logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "destinationArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "destinationArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DestinationArn",
"sensitive" : false,
"setterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.",
"setterMethodName" : "setDestinationArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"DestinationArn" : {
"beanStyleGetterMethodName" : "getDestinationArn",
"beanStyleSetterMethodName" : "setDestinationArn",
"c2jName" : "destinationArn",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #destinationArn(String)}.\n@param destinationArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #destinationArn(String)",
"deprecated" : false,
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "destinationArn",
"fluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "destinationArn",
"getterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@return The ARN of the CloudWatch Logs log group to receive access logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "destinationArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "destinationArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DestinationArn",
"sensitive" : false,
"setterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.",
"setterMethodName" : "setDestinationArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Format" : {
"beanStyleGetterMethodName" : "getFormat",
"beanStyleSetterMethodName" : "setFormat",
"c2jName" : "format",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #format(String)}.\n@param format a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #format(String)",
"deprecated" : false,
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "format",
"fluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "format",
"getterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@return A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "format",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "format",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Format",
"sensitive" : false,
"setterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"setterMethodName" : "setFormat",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getFormat",
"beanStyleSetterMethodName" : "setFormat",
"c2jName" : "format",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #format(String)}.\n@param format a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #format(String)",
"deprecated" : false,
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "format",
"fluentSetterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "format",
"getterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@return A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "format",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "format",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Format",
"sensitive" : false,
"setterDocumentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
\n@param format A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.",
"setterMethodName" : "setFormat",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "format",
"variableType" : "String",
"documentation" : "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDestinationArn",
"beanStyleSetterMethodName" : "setDestinationArn",
"c2jName" : "destinationArn",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #destinationArn(String)}.\n@param destinationArn a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #destinationArn(String)",
"deprecated" : false,
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "destinationArn",
"fluentSetterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "destinationArn",
"getterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@return The ARN of the CloudWatch Logs log group to receive access logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "destinationArn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "destinationArn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DestinationArn",
"sensitive" : false,
"setterDocumentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
\n@param destinationArn The ARN of the CloudWatch Logs log group to receive access logs.",
"setterMethodName" : "setDestinationArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "destinationArn",
"variableType" : "String",
"documentation" : "The ARN of the CloudWatch Logs log group to receive access logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "AccessLogSettings",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AccessLogSettings",
"variableName" : "accessLogSettings",
"variableType" : "AccessLogSettings",
"documentation" : null,
"simpleType" : "AccessLogSettings",
"variableSetterType" : "AccessLogSettings"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ApiKey" : {
"c2jName" : "ApiKey",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"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.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier of the API Key.
\n@return The identifier of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The value of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "The value of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "The value of the API Key.
\n@return The value of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "The value of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "The name of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "The name of the API Key.
\n@return The name of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "The name of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getCustomerId",
"beanStyleSetterMethodName" : "setCustomerId",
"c2jName" : "customerId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerId(String)}.\n@param customerId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerId(String)",
"deprecated" : false,
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customerId",
"fluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customerId",
"getterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@return An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "customerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "customerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerId",
"sensitive" : false,
"setterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"setterMethodName" : "setCustomerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "description",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The description of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"documentation" : "The description of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "The description of the API Key.
\n@return The description of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "The description of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getEnabled",
"beanStyleSetterMethodName" : "setEnabled",
"c2jName" : "enabled",
"c2jShape" : "Boolean",
"defaultConsumerFluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #enabled(Boolean)}.\n@param enabled a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #enabled(Boolean)",
"deprecated" : false,
"documentation" : "Specifies whether the API Key can be used by callers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "enabled",
"fluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "enabled",
"getterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@return Specifies whether the API Key can be used by callers.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "enabled",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "enabled",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Enabled",
"sensitive" : false,
"setterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.",
"setterMethodName" : "setEnabled",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : "Specifies whether the API Key can be used by callers.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getCreatedDate",
"beanStyleSetterMethodName" : "setCreatedDate",
"c2jName" : "createdDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #createdDate(Instant)}.\n@param createdDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #createdDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "createdDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "createdDate",
"getterDocumentation" : "The timestamp when the API Key was created.
\n@return The timestamp when the API Key was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "createdDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "createdDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.",
"setterMethodName" : "setCreatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getLastUpdatedDate",
"beanStyleSetterMethodName" : "setLastUpdatedDate",
"c2jName" : "lastUpdatedDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #lastUpdatedDate(Instant)}.\n@param lastUpdatedDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #lastUpdatedDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was last updated.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "lastUpdatedDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "lastUpdatedDate",
"getterDocumentation" : "The timestamp when the API Key was last updated.
\n@return The timestamp when the API Key was last updated.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "lastUpdatedDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "lastUpdatedDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "LastUpdatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.",
"setterMethodName" : "setLastUpdatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was last updated.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStageKeys",
"beanStyleSetterMethodName" : "setStageKeys",
"c2jName" : "stageKeys",
"c2jShape" : "ListOfString",
"defaultConsumerFluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #stageKeys(List)}.\n@param stageKeys a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageKeys(List)",
"deprecated" : false,
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageKeys",
"fluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageKeys",
"getterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of Stage resources that are associated with the ApiKey resource.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageKeys",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageKeys",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "StageKeys",
"sensitive" : false,
"setterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.",
"setterMethodName" : "setStageKeys",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "tags",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #tags(Map)}.\n@param tags a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(Map)",
"deprecated" : false,
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return The collection of tags. Each tag element is associated with a given resource.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CreatedDate" : {
"beanStyleGetterMethodName" : "getCreatedDate",
"beanStyleSetterMethodName" : "setCreatedDate",
"c2jName" : "createdDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #createdDate(Instant)}.\n@param createdDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #createdDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "createdDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "createdDate",
"getterDocumentation" : "The timestamp when the API Key was created.
\n@return The timestamp when the API Key was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "createdDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "createdDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.",
"setterMethodName" : "setCreatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"CustomerId" : {
"beanStyleGetterMethodName" : "getCustomerId",
"beanStyleSetterMethodName" : "setCustomerId",
"c2jName" : "customerId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerId(String)}.\n@param customerId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerId(String)",
"deprecated" : false,
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customerId",
"fluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customerId",
"getterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@return An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "customerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "customerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerId",
"sensitive" : false,
"setterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"setterMethodName" : "setCustomerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Description" : {
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "description",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The description of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"documentation" : "The description of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "The description of the API Key.
\n@return The description of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "The description of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Enabled" : {
"beanStyleGetterMethodName" : "getEnabled",
"beanStyleSetterMethodName" : "setEnabled",
"c2jName" : "enabled",
"c2jShape" : "Boolean",
"defaultConsumerFluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #enabled(Boolean)}.\n@param enabled a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #enabled(Boolean)",
"deprecated" : false,
"documentation" : "Specifies whether the API Key can be used by callers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "enabled",
"fluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "enabled",
"getterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@return Specifies whether the API Key can be used by callers.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "enabled",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "enabled",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Enabled",
"sensitive" : false,
"setterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.",
"setterMethodName" : "setEnabled",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : "Specifies whether the API Key can be used by callers.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Id" : {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier of the API Key.
\n@return The identifier of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"LastUpdatedDate" : {
"beanStyleGetterMethodName" : "getLastUpdatedDate",
"beanStyleSetterMethodName" : "setLastUpdatedDate",
"c2jName" : "lastUpdatedDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #lastUpdatedDate(Instant)}.\n@param lastUpdatedDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #lastUpdatedDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was last updated.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "lastUpdatedDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "lastUpdatedDate",
"getterDocumentation" : "The timestamp when the API Key was last updated.
\n@return The timestamp when the API Key was last updated.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "lastUpdatedDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "lastUpdatedDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "LastUpdatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.",
"setterMethodName" : "setLastUpdatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was last updated.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Name" : {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "The name of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "The name of the API Key.
\n@return The name of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "The name of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"StageKeys" : {
"beanStyleGetterMethodName" : "getStageKeys",
"beanStyleSetterMethodName" : "setStageKeys",
"c2jName" : "stageKeys",
"c2jShape" : "ListOfString",
"defaultConsumerFluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #stageKeys(List)}.\n@param stageKeys a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageKeys(List)",
"deprecated" : false,
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageKeys",
"fluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageKeys",
"getterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of Stage resources that are associated with the ApiKey resource.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageKeys",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageKeys",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "StageKeys",
"sensitive" : false,
"setterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.",
"setterMethodName" : "setStageKeys",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Tags" : {
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "tags",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #tags(Map)}.\n@param tags a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(Map)",
"deprecated" : false,
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return The collection of tags. Each tag element is associated with a given resource.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Value" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The value of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "The value of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "The value of the API Key.
\n@return The value of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "The value of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier of the API Key.
\n@return The identifier of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier of the API Key.
\n@param id The identifier of the API Key.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The value of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "The value of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "The value of the API Key.
\n@return The value of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "The value of the API Key.
\n@param value The value of the API Key.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "The value of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "The name of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "The name of the API Key.
\n@return The name of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "The name of the API Key.
\n@param name The name of the API Key.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "The name of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getCustomerId",
"beanStyleSetterMethodName" : "setCustomerId",
"c2jName" : "customerId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #customerId(String)}.\n@param customerId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #customerId(String)",
"deprecated" : false,
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "customerId",
"fluentSetterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "customerId",
"getterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@return An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "customerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "customerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "CustomerId",
"sensitive" : false,
"setterDocumentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
\n@param customerId An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.",
"setterMethodName" : "setCustomerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "customerId",
"variableType" : "String",
"documentation" : "An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDescription",
"beanStyleSetterMethodName" : "setDescription",
"c2jName" : "description",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The description of the API Key.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #description(String)}.\n@param description a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #description(String)",
"deprecated" : false,
"documentation" : "The description of the API Key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "description",
"fluentSetterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "description",
"getterDocumentation" : "The description of the API Key.
\n@return The description of the API Key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "description",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "description",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Description",
"sensitive" : false,
"setterDocumentation" : "The description of the API Key.
\n@param description The description of the API Key.",
"setterMethodName" : "setDescription",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "description",
"variableType" : "String",
"documentation" : "The description of the API Key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getEnabled",
"beanStyleSetterMethodName" : "setEnabled",
"c2jName" : "enabled",
"c2jShape" : "Boolean",
"defaultConsumerFluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #enabled(Boolean)}.\n@param enabled a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #enabled(Boolean)",
"deprecated" : false,
"documentation" : "Specifies whether the API Key can be used by callers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "enabled",
"fluentSetterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "enabled",
"getterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@return Specifies whether the API Key can be used by callers.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "enabled",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "enabled",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "Enabled",
"sensitive" : false,
"setterDocumentation" : "Specifies whether the API Key can be used by callers.
\n@param enabled Specifies whether the API Key can be used by callers.",
"setterMethodName" : "setEnabled",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "enabled",
"variableType" : "Boolean",
"documentation" : "Specifies whether the API Key can be used by callers.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getCreatedDate",
"beanStyleSetterMethodName" : "setCreatedDate",
"c2jName" : "createdDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was created.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #createdDate(Instant)}.\n@param createdDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #createdDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "createdDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "createdDate",
"getterDocumentation" : "The timestamp when the API Key was created.
\n@return The timestamp when the API Key was created.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "createdDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "createdDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "CreatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was created.
\n@param createdDate The timestamp when the API Key was created.",
"setterMethodName" : "setCreatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "createdDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was created.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getLastUpdatedDate",
"beanStyleSetterMethodName" : "setLastUpdatedDate",
"c2jName" : "lastUpdatedDate",
"c2jShape" : "Timestamp",
"defaultConsumerFluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\nThis is a convenience that creates an instance of the {@link Instant.Builder} avoiding the need to create one manually via {@link Instant#builder()}.\n\nWhen the {@link Consumer} completes, {@link Instant.Builder#build()} is called immediately and its result is passed to {@link #lastUpdatedDate(Instant)}.\n@param lastUpdatedDate a consumer that will call methods on {@link Instant.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #lastUpdatedDate(Instant)",
"deprecated" : false,
"documentation" : "The timestamp when the API Key was last updated.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "lastUpdatedDate",
"fluentSetterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "lastUpdatedDate",
"getterDocumentation" : "The timestamp when the API Key was last updated.
\n@return The timestamp when the API Key was last updated.",
"getterModel" : {
"returnType" : "java.time.Instant",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "lastUpdatedDate",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "lastUpdatedDate",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INSTANT",
"name" : "LastUpdatedDate",
"sensitive" : false,
"setterDocumentation" : "The timestamp when the API Key was last updated.
\n@param lastUpdatedDate The timestamp when the API Key was last updated.",
"setterMethodName" : "setLastUpdatedDate",
"setterModel" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : null,
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.time.Instant",
"variableName" : "lastUpdatedDate",
"variableType" : "java.time.Instant",
"documentation" : "The timestamp when the API Key was last updated.
",
"simpleType" : "Instant",
"variableSetterType" : "java.time.Instant"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStageKeys",
"beanStyleSetterMethodName" : "setStageKeys",
"c2jName" : "stageKeys",
"c2jShape" : "ListOfString",
"defaultConsumerFluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #stageKeys(List)}.\n@param stageKeys a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageKeys(List)",
"deprecated" : false,
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageKeys",
"fluentSetterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageKeys",
"getterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of Stage resources that are associated with the ApiKey resource.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageKeys",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageKeys",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "StageKeys",
"sensitive" : false,
"setterDocumentation" : "A list of Stage resources that are associated with the ApiKey resource.
\n@param stageKeys A list of Stage resources that are associated with the ApiKey resource.",
"setterMethodName" : "setStageKeys",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "stageKeys",
"variableType" : "java.util.List",
"documentation" : "A list of Stage resources that are associated with the ApiKey resource.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "tags",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #tags(Map)}.\n@param tags a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(Map)",
"deprecated" : false,
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return The collection of tags. Each tag element is associated with a given resource.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "The collection of tags. Each tag element is associated with a given resource.
\n@param tags The collection of tags. Each tag element is associated with a given resource.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "tags",
"variableType" : "java.util.Map",
"documentation" : "The collection of tags. Each tag element is associated with a given resource.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ApiKey",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ApiKey",
"variableName" : "apiKey",
"variableType" : "ApiKey",
"documentation" : null,
"simpleType" : "ApiKey",
"variableSetterType" : "ApiKey"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ApiKeySourceType" : {
"c2jName" : "ApiKeySourceType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "HEADER",
"value" : "HEADER"
}, {
"name" : "AUTHORIZER",
"value" : "AUTHORIZER"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ApiKeySourceType",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ApiKeySourceType",
"variableName" : "apiKeySourceType",
"variableType" : "ApiKeySourceType",
"documentation" : null,
"simpleType" : "ApiKeySourceType",
"variableSetterType" : "ApiKeySourceType"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ApiKeysFormat" : {
"c2jName" : "ApiKeysFormat",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "CSV",
"value" : "csv"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ApiKeysFormat",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ApiKeysFormat",
"variableName" : "apiKeysFormat",
"variableType" : "ApiKeysFormat",
"documentation" : null,
"simpleType" : "ApiKeysFormat",
"variableSetterType" : "ApiKeysFormat"
},
"wrapper" : false,
"xmlNamespace" : null
},
"ApiStage" : {
"c2jName" : "ApiStage",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getApiId",
"beanStyleSetterMethodName" : "setApiId",
"c2jName" : "apiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #apiId(String)}.\n@param apiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #apiId(String)",
"deprecated" : false,
"documentation" : "API Id of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "apiId",
"fluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "apiId",
"getterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@return API Id of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "apiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "apiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ApiId",
"sensitive" : false,
"setterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.",
"setterMethodName" : "setApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : "API Id of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@return API stage name of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getThrottle",
"beanStyleSetterMethodName" : "setThrottle",
"c2jName" : "throttle",
"c2jShape" : "MapOfApiStageThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #throttle(Map)}.\n@param throttle a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #throttle(Map)",
"deprecated" : false,
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "throttle",
"fluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "throttle",
"getterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Map containing method level throttling information for API stage in a usage plan.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "throttle",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "throttle",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "ThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link ThrottleSettings.Builder} avoiding the need to create one manually via {@link ThrottleSettings#builder()}.\n\nWhen the {@link Consumer} completes, {@link ThrottleSettings.Builder#build()} is called immediately and its result is passed to {@link #value(ThrottleSettings)}.\n@param value a consumer that will call methods on {@link ThrottleSettings.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(ThrottleSettings)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "ThrottleSettings",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : null,
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : "",
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Throttle",
"sensitive" : false,
"setterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.",
"setterMethodName" : "setThrottle",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ApiId" : {
"beanStyleGetterMethodName" : "getApiId",
"beanStyleSetterMethodName" : "setApiId",
"c2jName" : "apiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #apiId(String)}.\n@param apiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #apiId(String)",
"deprecated" : false,
"documentation" : "API Id of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "apiId",
"fluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "apiId",
"getterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@return API Id of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "apiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "apiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ApiId",
"sensitive" : false,
"setterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.",
"setterMethodName" : "setApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : "API Id of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Stage" : {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@return API stage name of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Throttle" : {
"beanStyleGetterMethodName" : "getThrottle",
"beanStyleSetterMethodName" : "setThrottle",
"c2jName" : "throttle",
"c2jShape" : "MapOfApiStageThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #throttle(Map)}.\n@param throttle a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #throttle(Map)",
"deprecated" : false,
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "throttle",
"fluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "throttle",
"getterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Map containing method level throttling information for API stage in a usage plan.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "throttle",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "throttle",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "ThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link ThrottleSettings.Builder} avoiding the need to create one manually via {@link ThrottleSettings#builder()}.\n\nWhen the {@link Consumer} completes, {@link ThrottleSettings.Builder#build()} is called immediately and its result is passed to {@link #value(ThrottleSettings)}.\n@param value a consumer that will call methods on {@link ThrottleSettings.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(ThrottleSettings)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "ThrottleSettings",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : null,
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : "",
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Throttle",
"sensitive" : false,
"setterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.",
"setterMethodName" : "setThrottle",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getApiId",
"beanStyleSetterMethodName" : "setApiId",
"c2jName" : "apiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #apiId(String)}.\n@param apiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #apiId(String)",
"deprecated" : false,
"documentation" : "API Id of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "apiId",
"fluentSetterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "apiId",
"getterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@return API Id of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "apiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "apiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ApiId",
"sensitive" : false,
"setterDocumentation" : "API Id of the associated API stage in a usage plan.
\n@param apiId API Id of the associated API stage in a usage plan.",
"setterMethodName" : "setApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "apiId",
"variableType" : "String",
"documentation" : "API Id of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@return API stage name of the associated API stage in a usage plan.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "API stage name of the associated API stage in a usage plan.
\n@param stage API stage name of the associated API stage in a usage plan.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "API stage name of the associated API stage in a usage plan.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getThrottle",
"beanStyleSetterMethodName" : "setThrottle",
"c2jName" : "throttle",
"c2jShape" : "MapOfApiStageThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #throttle(Map)}.\n@param throttle a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #throttle(Map)",
"deprecated" : false,
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "throttle",
"fluentSetterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "throttle",
"getterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Map containing method level throttling information for API stage in a usage plan.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "throttle",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "throttle",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "ThrottleSettings",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link ThrottleSettings.Builder} avoiding the need to create one manually via {@link ThrottleSettings#builder()}.\n\nWhen the {@link Consumer} completes, {@link ThrottleSettings.Builder#build()} is called immediately and its result is passed to {@link #value(ThrottleSettings)}.\n@param value a consumer that will call methods on {@link ThrottleSettings.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(ThrottleSettings)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "ThrottleSettings",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : null,
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "ThrottleSettings",
"variableName" : "value",
"variableType" : "ThrottleSettings",
"documentation" : "",
"simpleType" : "ThrottleSettings",
"variableSetterType" : "ThrottleSettings"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "Throttle",
"sensitive" : false,
"setterDocumentation" : "Map containing method level throttling information for API stage in a usage plan.
\n@param throttle Map containing method level throttling information for API stage in a usage plan.",
"setterMethodName" : "setThrottle",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "throttle",
"variableType" : "java.util.Map",
"documentation" : "Map containing method level throttling information for API stage in a usage plan.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ApiStage",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "ApiStage",
"variableName" : "apiStage",
"variableType" : "ApiStage",
"documentation" : null,
"simpleType" : "ApiStage",
"variableSetterType" : "ApiStage"
},
"wrapper" : false,
"xmlNamespace" : null
},
"Authorizer" : {
"c2jName" : "Authorizer",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier for the authorizer resource.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier for the authorizer resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier for the authorizer resource.
\n@return The identifier for the authorizer resource.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier for the authorizer resource.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "[Required] The name of the authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "[Required] The name of the authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "[Required] The name of the authorizer.
\n@return [Required] The name of the authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "[Required] The name of the authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getTypeAsString",
"beanStyleSetterMethodName" : "setType",
"c2jName" : "type",
"c2jShape" : "AuthorizerType",
"defaultConsumerFluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #typeAsString(String)}.\n@param type a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #type(String)",
"deprecated" : false,
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"endpointDiscoveryId" : false,
"enumType" : "AuthorizerType",
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : "type",
"fluentEnumSetterMethodName" : "type",
"fluentGetterMethodName" : "typeAsString",
"fluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType\n@return Returns a reference to this object so that method calls can be chained together.\n@see AuthorizerType",
"fluentSetterMethodName" : "type",
"getterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #type} will return {@link AuthorizerType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #typeAsString}.\n
\n@return The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "type",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "type",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Type",
"sensitive" : false,
"setterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"setterMethodName" : "setType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getProviderARNs",
"beanStyleSetterMethodName" : "setProviderARNs",
"c2jName" : "providerARNs",
"c2jShape" : "ListOfARNs",
"defaultConsumerFluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #providerARNs(List)}.\n@param providerARNs a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #providerARNs(List)",
"deprecated" : false,
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "providerARNs",
"fluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "providerARNs",
"getterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "providerARNs",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "providerARNs",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "ProviderARN",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "ProviderARNs",
"sensitive" : false,
"setterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"setterMethodName" : "setProviderARNs",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthType",
"beanStyleSetterMethodName" : "setAuthType",
"c2jName" : "authType",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authType(String)}.\n@param authType a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authType(String)",
"deprecated" : false,
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authType",
"fluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authType",
"getterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@return Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthType",
"sensitive" : false,
"setterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"setterMethodName" : "setAuthType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerUri",
"beanStyleSetterMethodName" : "setAuthorizerUri",
"c2jName" : "authorizerUri",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerUri(String)}.\n@param authorizerUri a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerUri(String)",
"deprecated" : false,
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerUri",
"fluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerUri",
"getterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@return Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerUri",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerUri",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerUri",
"sensitive" : false,
"setterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"setterMethodName" : "setAuthorizerUri",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerCredentials",
"beanStyleSetterMethodName" : "setAuthorizerCredentials",
"c2jName" : "authorizerCredentials",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerCredentials(String)}.\n@param authorizerCredentials a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerCredentials(String)",
"deprecated" : false,
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerCredentials",
"fluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerCredentials",
"getterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@return Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerCredentials",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerCredentials",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerCredentials",
"sensitive" : false,
"setterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"setterMethodName" : "setAuthorizerCredentials",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getIdentitySource",
"beanStyleSetterMethodName" : "setIdentitySource",
"c2jName" : "identitySource",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identitySource(String)}.\n@param identitySource a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identitySource(String)",
"deprecated" : false,
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identitySource",
"fluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identitySource",
"getterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identitySource",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identitySource",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentitySource",
"sensitive" : false,
"setterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"setterMethodName" : "setIdentitySource",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getIdentityValidationExpression",
"beanStyleSetterMethodName" : "setIdentityValidationExpression",
"c2jName" : "identityValidationExpression",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identityValidationExpression(String)}.\n@param identityValidationExpression a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityValidationExpression(String)",
"deprecated" : false,
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityValidationExpression",
"fluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityValidationExpression",
"getterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@return A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identityValidationExpression",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identityValidationExpression",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityValidationExpression",
"sensitive" : false,
"setterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"setterMethodName" : "setIdentityValidationExpression",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerResultTtlInSeconds",
"beanStyleSetterMethodName" : "setAuthorizerResultTtlInSeconds",
"c2jName" : "authorizerResultTtlInSeconds",
"c2jShape" : "NullableInteger",
"defaultConsumerFluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #authorizerResultTtlInSeconds(Integer)}.\n@param authorizerResultTtlInSeconds a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerResultTtlInSeconds(Integer)",
"deprecated" : false,
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerResultTtlInSeconds",
"fluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerResultTtlInSeconds",
"getterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@return The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerResultTtlInSeconds",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerResultTtlInSeconds",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "AuthorizerResultTtlInSeconds",
"sensitive" : false,
"setterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"setterMethodName" : "setAuthorizerResultTtlInSeconds",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AuthType" : {
"beanStyleGetterMethodName" : "getAuthType",
"beanStyleSetterMethodName" : "setAuthType",
"c2jName" : "authType",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authType(String)}.\n@param authType a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authType(String)",
"deprecated" : false,
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authType",
"fluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authType",
"getterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@return Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthType",
"sensitive" : false,
"setterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"setterMethodName" : "setAuthType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"AuthorizerCredentials" : {
"beanStyleGetterMethodName" : "getAuthorizerCredentials",
"beanStyleSetterMethodName" : "setAuthorizerCredentials",
"c2jName" : "authorizerCredentials",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerCredentials(String)}.\n@param authorizerCredentials a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerCredentials(String)",
"deprecated" : false,
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerCredentials",
"fluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerCredentials",
"getterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@return Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerCredentials",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerCredentials",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerCredentials",
"sensitive" : false,
"setterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"setterMethodName" : "setAuthorizerCredentials",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"AuthorizerResultTtlInSeconds" : {
"beanStyleGetterMethodName" : "getAuthorizerResultTtlInSeconds",
"beanStyleSetterMethodName" : "setAuthorizerResultTtlInSeconds",
"c2jName" : "authorizerResultTtlInSeconds",
"c2jShape" : "NullableInteger",
"defaultConsumerFluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #authorizerResultTtlInSeconds(Integer)}.\n@param authorizerResultTtlInSeconds a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerResultTtlInSeconds(Integer)",
"deprecated" : false,
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerResultTtlInSeconds",
"fluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerResultTtlInSeconds",
"getterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@return The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerResultTtlInSeconds",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerResultTtlInSeconds",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "AuthorizerResultTtlInSeconds",
"sensitive" : false,
"setterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"setterMethodName" : "setAuthorizerResultTtlInSeconds",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"AuthorizerUri" : {
"beanStyleGetterMethodName" : "getAuthorizerUri",
"beanStyleSetterMethodName" : "setAuthorizerUri",
"c2jName" : "authorizerUri",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerUri(String)}.\n@param authorizerUri a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerUri(String)",
"deprecated" : false,
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerUri",
"fluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerUri",
"getterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@return Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerUri",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerUri",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerUri",
"sensitive" : false,
"setterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"setterMethodName" : "setAuthorizerUri",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Id" : {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier for the authorizer resource.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier for the authorizer resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier for the authorizer resource.
\n@return The identifier for the authorizer resource.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier for the authorizer resource.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentitySource" : {
"beanStyleGetterMethodName" : "getIdentitySource",
"beanStyleSetterMethodName" : "setIdentitySource",
"c2jName" : "identitySource",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identitySource(String)}.\n@param identitySource a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identitySource(String)",
"deprecated" : false,
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identitySource",
"fluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identitySource",
"getterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identitySource",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identitySource",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentitySource",
"sensitive" : false,
"setterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"setterMethodName" : "setIdentitySource",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentityValidationExpression" : {
"beanStyleGetterMethodName" : "getIdentityValidationExpression",
"beanStyleSetterMethodName" : "setIdentityValidationExpression",
"c2jName" : "identityValidationExpression",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identityValidationExpression(String)}.\n@param identityValidationExpression a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityValidationExpression(String)",
"deprecated" : false,
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityValidationExpression",
"fluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityValidationExpression",
"getterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@return A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identityValidationExpression",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identityValidationExpression",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityValidationExpression",
"sensitive" : false,
"setterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"setterMethodName" : "setIdentityValidationExpression",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Name" : {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "[Required] The name of the authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "[Required] The name of the authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "[Required] The name of the authorizer.
\n@return [Required] The name of the authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "[Required] The name of the authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"ProviderARNs" : {
"beanStyleGetterMethodName" : "getProviderARNs",
"beanStyleSetterMethodName" : "setProviderARNs",
"c2jName" : "providerARNs",
"c2jShape" : "ListOfARNs",
"defaultConsumerFluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #providerARNs(List)}.\n@param providerARNs a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #providerARNs(List)",
"deprecated" : false,
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "providerARNs",
"fluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "providerARNs",
"getterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "providerARNs",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "providerARNs",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "ProviderARN",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "ProviderARNs",
"sensitive" : false,
"setterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"setterMethodName" : "setProviderARNs",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Type" : {
"beanStyleGetterMethodName" : "getTypeAsString",
"beanStyleSetterMethodName" : "setType",
"c2jName" : "type",
"c2jShape" : "AuthorizerType",
"defaultConsumerFluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #typeAsString(String)}.\n@param type a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #type(String)",
"deprecated" : false,
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"endpointDiscoveryId" : false,
"enumType" : "AuthorizerType",
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : "type",
"fluentEnumSetterMethodName" : "type",
"fluentGetterMethodName" : "typeAsString",
"fluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType\n@return Returns a reference to this object so that method calls can be chained together.\n@see AuthorizerType",
"fluentSetterMethodName" : "type",
"getterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #type} will return {@link AuthorizerType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #typeAsString}.\n
\n@return The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "type",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "type",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Type",
"sensitive" : false,
"setterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"setterMethodName" : "setType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getId",
"beanStyleSetterMethodName" : "setId",
"c2jName" : "id",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identifier for the authorizer resource.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #id(String)}.\n@param id a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #id(String)",
"deprecated" : false,
"documentation" : "The identifier for the authorizer resource.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "id",
"fluentSetterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "id",
"getterDocumentation" : "The identifier for the authorizer resource.
\n@return The identifier for the authorizer resource.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "id",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "id",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Id",
"sensitive" : false,
"setterDocumentation" : "The identifier for the authorizer resource.
\n@param id The identifier for the authorizer resource.",
"setterMethodName" : "setId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "id",
"variableType" : "String",
"documentation" : "The identifier for the authorizer resource.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getName",
"beanStyleSetterMethodName" : "setName",
"c2jName" : "name",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "[Required] The name of the authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #name(String)}.\n@param name a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #name(String)",
"deprecated" : false,
"documentation" : "[Required] The name of the authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "name",
"fluentSetterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "name",
"getterDocumentation" : "[Required] The name of the authorizer.
\n@return [Required] The name of the authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "name",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "name",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Name",
"sensitive" : false,
"setterDocumentation" : "[Required] The name of the authorizer.
\n@param name [Required] The name of the authorizer.",
"setterMethodName" : "setName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "name",
"variableType" : "String",
"documentation" : "[Required] The name of the authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getTypeAsString",
"beanStyleSetterMethodName" : "setType",
"c2jName" : "type",
"c2jShape" : "AuthorizerType",
"defaultConsumerFluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #typeAsString(String)}.\n@param type a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #type(String)",
"deprecated" : false,
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"endpointDiscoveryId" : false,
"enumType" : "AuthorizerType",
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : "type",
"fluentEnumSetterMethodName" : "type",
"fluentGetterMethodName" : "typeAsString",
"fluentSetterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType\n@return Returns a reference to this object so that method calls can be chained together.\n@see AuthorizerType",
"fluentSetterMethodName" : "type",
"getterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #type} will return {@link AuthorizerType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #typeAsString}.\n
\n@return The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "type",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "type",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Type",
"sensitive" : false,
"setterDocumentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
\n@param type The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.\n@see AuthorizerType",
"setterMethodName" : "setType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "type",
"variableType" : "String",
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getProviderARNs",
"beanStyleSetterMethodName" : "setProviderARNs",
"c2jName" : "providerARNs",
"c2jShape" : "ListOfARNs",
"defaultConsumerFluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #providerARNs(List)}.\n@param providerARNs a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #providerARNs(List)",
"deprecated" : false,
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "providerARNs",
"fluentSetterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "providerARNs",
"getterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "providerARNs",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "providerARNs",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "ProviderARN",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #member(String)}.\n@param member a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "ProviderARNs",
"sensitive" : false,
"setterDocumentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
\n@param providerARNs A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.",
"setterMethodName" : "setProviderARNs",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "providerARNs",
"variableType" : "java.util.List",
"documentation" : "A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthType",
"beanStyleSetterMethodName" : "setAuthType",
"c2jName" : "authType",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authType(String)}.\n@param authType a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authType(String)",
"deprecated" : false,
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authType",
"fluentSetterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authType",
"getterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@return Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthType",
"sensitive" : false,
"setterDocumentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
\n@param authType Optional customer-defined field, used in OpenAPI imports and exports without functional impact.",
"setterMethodName" : "setAuthType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authType",
"variableType" : "String",
"documentation" : "Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerUri",
"beanStyleSetterMethodName" : "setAuthorizerUri",
"c2jName" : "authorizerUri",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerUri(String)}.\n@param authorizerUri a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerUri(String)",
"deprecated" : false,
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerUri",
"fluentSetterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerUri",
"getterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@return Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerUri",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerUri",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerUri",
"sensitive" : false,
"setterDocumentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
\n@param authorizerUri Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.",
"setterMethodName" : "setAuthorizerUri",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerUri",
"variableType" : "String",
"documentation" : "Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerCredentials",
"beanStyleSetterMethodName" : "setAuthorizerCredentials",
"c2jName" : "authorizerCredentials",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #authorizerCredentials(String)}.\n@param authorizerCredentials a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerCredentials(String)",
"deprecated" : false,
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerCredentials",
"fluentSetterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerCredentials",
"getterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@return Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerCredentials",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerCredentials",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "AuthorizerCredentials",
"sensitive" : false,
"setterDocumentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
\n@param authorizerCredentials Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.",
"setterMethodName" : "setAuthorizerCredentials",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "authorizerCredentials",
"variableType" : "String",
"documentation" : "Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getIdentitySource",
"beanStyleSetterMethodName" : "setIdentitySource",
"c2jName" : "identitySource",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identitySource(String)}.\n@param identitySource a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identitySource(String)",
"deprecated" : false,
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identitySource",
"fluentSetterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identitySource",
"getterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@return The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identitySource",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identitySource",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentitySource",
"sensitive" : false,
"setterDocumentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
\n@param identitySource The identity source for which authorization is requested. - For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"setterMethodName" : "setIdentitySource",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identitySource",
"variableType" : "String",
"documentation" : "The identity source for which authorization is requested.
- For a
TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. - For the
REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getIdentityValidationExpression",
"beanStyleSetterMethodName" : "setIdentityValidationExpression",
"c2jName" : "identityValidationExpression",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #identityValidationExpression(String)}.\n@param identityValidationExpression a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityValidationExpression(String)",
"deprecated" : false,
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityValidationExpression",
"fluentSetterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityValidationExpression",
"getterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@return A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "identityValidationExpression",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "identityValidationExpression",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityValidationExpression",
"sensitive" : false,
"setterDocumentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
\n@param identityValidationExpression A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.",
"setterMethodName" : "setIdentityValidationExpression",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityValidationExpression",
"variableType" : "String",
"documentation" : "A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getAuthorizerResultTtlInSeconds",
"beanStyleSetterMethodName" : "setAuthorizerResultTtlInSeconds",
"c2jName" : "authorizerResultTtlInSeconds",
"c2jShape" : "NullableInteger",
"defaultConsumerFluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #authorizerResultTtlInSeconds(Integer)}.\n@param authorizerResultTtlInSeconds a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #authorizerResultTtlInSeconds(Integer)",
"deprecated" : false,
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "authorizerResultTtlInSeconds",
"fluentSetterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "authorizerResultTtlInSeconds",
"getterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@return The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "authorizerResultTtlInSeconds",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "authorizerResultTtlInSeconds",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "AuthorizerResultTtlInSeconds",
"sensitive" : false,
"setterDocumentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
\n@param authorizerResultTtlInSeconds The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.",
"setterMethodName" : "setAuthorizerResultTtlInSeconds",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "authorizerResultTtlInSeconds",
"variableType" : "Integer",
"documentation" : "The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "Authorizer",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "Authorizer",
"variableName" : "authorizer",
"variableType" : "Authorizer",
"documentation" : null,
"simpleType" : "Authorizer",
"variableSetterType" : "Authorizer"
},
"wrapper" : false,
"xmlNamespace" : null
},
"AuthorizerType" : {
"c2jName" : "AuthorizerType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "TOKEN",
"value" : "TOKEN"
}, {
"name" : "REQUEST",
"value" : "REQUEST"
}, {
"name" : "COGNITO_USER_POOLS",
"value" : "COGNITO_USER_POOLS"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "AuthorizerType",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AuthorizerType",
"variableName" : "authorizerType",
"variableType" : "AuthorizerType",
"documentation" : null,
"simpleType" : "AuthorizerType",
"variableSetterType" : "AuthorizerType"
},
"wrapper" : false,
"xmlNamespace" : null
},
"BadRequestException" : {
"c2jName" : "BadRequestException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "BadRequestException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : 400,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "BadRequestException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "BadRequestException",
"variableName" : "badRequestException",
"variableType" : "BadRequestException",
"documentation" : null,
"simpleType" : "BadRequestException",
"variableSetterType" : "BadRequestException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"BasePathMapping" : {
"c2jName" : "BasePathMapping",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"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. ",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getBasePath",
"beanStyleSetterMethodName" : "setBasePath",
"c2jName" : "basePath",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #basePath(String)}.\n@param basePath a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #basePath(String)",
"deprecated" : false,
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "basePath",
"fluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "basePath",
"getterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@return The base path name that callers of the API must provide as part of the URL after the domain name.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "basePath",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "basePath",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "BasePath",
"sensitive" : false,
"setterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.",
"setterMethodName" : "setBasePath",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getRestApiId",
"beanStyleSetterMethodName" : "setRestApiId",
"c2jName" : "restApiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The string identifier of the associated RestApi.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #restApiId(String)}.\n@param restApiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #restApiId(String)",
"deprecated" : false,
"documentation" : "The string identifier of the associated RestApi.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "restApiId",
"fluentSetterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "restApiId",
"getterDocumentation" : "The string identifier of the associated RestApi.
\n@return The string identifier of the associated RestApi.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "restApiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "restApiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RestApiId",
"sensitive" : false,
"setterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.",
"setterMethodName" : "setRestApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : "The string identifier of the associated RestApi.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the associated stage.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "The name of the associated stage.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "The name of the associated stage.
\n@return The name of the associated stage.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "The name of the associated stage.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"BasePath" : {
"beanStyleGetterMethodName" : "getBasePath",
"beanStyleSetterMethodName" : "setBasePath",
"c2jName" : "basePath",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #basePath(String)}.\n@param basePath a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #basePath(String)",
"deprecated" : false,
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "basePath",
"fluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "basePath",
"getterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@return The base path name that callers of the API must provide as part of the URL after the domain name.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "basePath",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "basePath",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "BasePath",
"sensitive" : false,
"setterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.",
"setterMethodName" : "setBasePath",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"RestApiId" : {
"beanStyleGetterMethodName" : "getRestApiId",
"beanStyleSetterMethodName" : "setRestApiId",
"c2jName" : "restApiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The string identifier of the associated RestApi.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #restApiId(String)}.\n@param restApiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #restApiId(String)",
"deprecated" : false,
"documentation" : "The string identifier of the associated RestApi.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "restApiId",
"fluentSetterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "restApiId",
"getterDocumentation" : "The string identifier of the associated RestApi.
\n@return The string identifier of the associated RestApi.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "restApiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "restApiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RestApiId",
"sensitive" : false,
"setterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.",
"setterMethodName" : "setRestApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : "The string identifier of the associated RestApi.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Stage" : {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the associated stage.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "The name of the associated stage.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "The name of the associated stage.
\n@return The name of the associated stage.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "The name of the associated stage.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getBasePath",
"beanStyleSetterMethodName" : "setBasePath",
"c2jName" : "basePath",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #basePath(String)}.\n@param basePath a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #basePath(String)",
"deprecated" : false,
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "basePath",
"fluentSetterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "basePath",
"getterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@return The base path name that callers of the API must provide as part of the URL after the domain name.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "basePath",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "basePath",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "BasePath",
"sensitive" : false,
"setterDocumentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
\n@param basePath The base path name that callers of the API must provide as part of the URL after the domain name.",
"setterMethodName" : "setBasePath",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "basePath",
"variableType" : "String",
"documentation" : "The base path name that callers of the API must provide as part of the URL after the domain name.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getRestApiId",
"beanStyleSetterMethodName" : "setRestApiId",
"c2jName" : "restApiId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The string identifier of the associated RestApi.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #restApiId(String)}.\n@param restApiId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #restApiId(String)",
"deprecated" : false,
"documentation" : "The string identifier of the associated RestApi.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "restApiId",
"fluentSetterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "restApiId",
"getterDocumentation" : "The string identifier of the associated RestApi.
\n@return The string identifier of the associated RestApi.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "restApiId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "restApiId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "RestApiId",
"sensitive" : false,
"setterDocumentation" : "The string identifier of the associated RestApi.
\n@param restApiId The string identifier of the associated RestApi.",
"setterMethodName" : "setRestApiId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "restApiId",
"variableType" : "String",
"documentation" : "The string identifier of the associated RestApi.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStage",
"beanStyleSetterMethodName" : "setStage",
"c2jName" : "stage",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The name of the associated stage.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #stage(String)}.\n@param stage a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stage(String)",
"deprecated" : false,
"documentation" : "The name of the associated stage.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stage",
"fluentSetterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stage",
"getterDocumentation" : "The name of the associated stage.
\n@return The name of the associated stage.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stage",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stage",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Stage",
"sensitive" : false,
"setterDocumentation" : "The name of the associated stage.
\n@param stage The name of the associated stage.",
"setterMethodName" : "setStage",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "stage",
"variableType" : "String",
"documentation" : "The name of the associated stage.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "BasePathMapping",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "BasePathMapping",
"variableName" : "basePathMapping",
"variableType" : "BasePathMapping",
"documentation" : null,
"simpleType" : "BasePathMapping",
"variableSetterType" : "BasePathMapping"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CacheClusterStatus" : {
"c2jName" : "CacheClusterStatus",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Returns the status of the CacheCluster.
",
"endpointDiscovery" : null,
"enums" : [ {
"name" : "CREATE_IN_PROGRESS",
"value" : "CREATE_IN_PROGRESS"
}, {
"name" : "AVAILABLE",
"value" : "AVAILABLE"
}, {
"name" : "DELETE_IN_PROGRESS",
"value" : "DELETE_IN_PROGRESS"
}, {
"name" : "NOT_AVAILABLE",
"value" : "NOT_AVAILABLE"
}, {
"name" : "FLUSH_IN_PROGRESS",
"value" : "FLUSH_IN_PROGRESS"
} ],
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CacheClusterStatus",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CacheClusterStatus",
"variableName" : "cacheClusterStatus",
"variableType" : "CacheClusterStatus",
"documentation" : null,
"simpleType" : "CacheClusterStatus",
"variableSetterType" : "CacheClusterStatus"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CanarySettings" : {
"c2jName" : "CanarySettings",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Configuration settings of a canary deployment.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"beanStyleGetterMethodName" : "getPercentTraffic",
"beanStyleSetterMethodName" : "setPercentTraffic",
"c2jName" : "percentTraffic",
"c2jShape" : "Double",
"defaultConsumerFluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\nThis is a convenience that creates an instance of the {@link Double.Builder} avoiding the need to create one manually via {@link Double#builder()}.\n\nWhen the {@link Consumer} completes, {@link Double.Builder#build()} is called immediately and its result is passed to {@link #percentTraffic(Double)}.\n@param percentTraffic a consumer that will call methods on {@link Double.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #percentTraffic(Double)",
"deprecated" : false,
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "percentTraffic",
"fluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "percentTraffic",
"getterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@return The percent (0-100) of traffic diverted to a canary deployment.",
"getterModel" : {
"returnType" : "Double",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "percentTraffic",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "percentTraffic",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "DOUBLE",
"name" : "PercentTraffic",
"sensitive" : false,
"setterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.",
"setterMethodName" : "setPercentTraffic",
"setterModel" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : null,
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDeploymentId",
"beanStyleSetterMethodName" : "setDeploymentId",
"c2jName" : "deploymentId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ID of the canary deployment.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #deploymentId(String)}.\n@param deploymentId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #deploymentId(String)",
"deprecated" : false,
"documentation" : "The ID of the canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "deploymentId",
"fluentSetterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "deploymentId",
"getterDocumentation" : "The ID of the canary deployment.
\n@return The ID of the canary deployment.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "deploymentId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "deploymentId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DeploymentId",
"sensitive" : false,
"setterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.",
"setterMethodName" : "setDeploymentId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : "The ID of the canary deployment.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStageVariableOverrides",
"beanStyleSetterMethodName" : "setStageVariableOverrides",
"c2jName" : "stageVariableOverrides",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #stageVariableOverrides(Map)}.\n@param stageVariableOverrides a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageVariableOverrides(Map)",
"deprecated" : false,
"documentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageVariableOverrides",
"fluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n@param stageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageVariableOverrides",
"getterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageVariableOverrides",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageVariableOverrides",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "StageVariableOverrides",
"sensitive" : false,
"setterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n@param stageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.",
"setterMethodName" : "setStageVariableOverrides",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "stageVariableOverrides",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "stageVariableOverrides",
"variableType" : "java.util.Map",
"documentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getUseStageCache",
"beanStyleSetterMethodName" : "setUseStageCache",
"c2jName" : "useStageCache",
"c2jShape" : "Boolean",
"defaultConsumerFluentSetterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #useStageCache(Boolean)}.\n@param useStageCache a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #useStageCache(Boolean)",
"deprecated" : false,
"documentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "useStageCache",
"fluentSetterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@param useStageCache A Boolean flag to indicate whether the canary deployment uses the stage cache or not.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "useStageCache",
"getterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@return A Boolean flag to indicate whether the canary deployment uses the stage cache or not.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "useStageCache",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "useStageCache",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "UseStageCache",
"sensitive" : false,
"setterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@param useStageCache A Boolean flag to indicate whether the canary deployment uses the stage cache or not.",
"setterMethodName" : "setUseStageCache",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "useStageCache",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "useStageCache",
"variableType" : "Boolean",
"documentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"DeploymentId" : {
"beanStyleGetterMethodName" : "getDeploymentId",
"beanStyleSetterMethodName" : "setDeploymentId",
"c2jName" : "deploymentId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ID of the canary deployment.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #deploymentId(String)}.\n@param deploymentId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #deploymentId(String)",
"deprecated" : false,
"documentation" : "The ID of the canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "deploymentId",
"fluentSetterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "deploymentId",
"getterDocumentation" : "The ID of the canary deployment.
\n@return The ID of the canary deployment.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "deploymentId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "deploymentId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DeploymentId",
"sensitive" : false,
"setterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.",
"setterMethodName" : "setDeploymentId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : "The ID of the canary deployment.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"PercentTraffic" : {
"beanStyleGetterMethodName" : "getPercentTraffic",
"beanStyleSetterMethodName" : "setPercentTraffic",
"c2jName" : "percentTraffic",
"c2jShape" : "Double",
"defaultConsumerFluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\nThis is a convenience that creates an instance of the {@link Double.Builder} avoiding the need to create one manually via {@link Double#builder()}.\n\nWhen the {@link Consumer} completes, {@link Double.Builder#build()} is called immediately and its result is passed to {@link #percentTraffic(Double)}.\n@param percentTraffic a consumer that will call methods on {@link Double.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #percentTraffic(Double)",
"deprecated" : false,
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "percentTraffic",
"fluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "percentTraffic",
"getterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@return The percent (0-100) of traffic diverted to a canary deployment.",
"getterModel" : {
"returnType" : "Double",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "percentTraffic",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "percentTraffic",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "DOUBLE",
"name" : "PercentTraffic",
"sensitive" : false,
"setterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.",
"setterMethodName" : "setPercentTraffic",
"setterModel" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : null,
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"StageVariableOverrides" : {
"beanStyleGetterMethodName" : "getStageVariableOverrides",
"beanStyleSetterMethodName" : "setStageVariableOverrides",
"c2jName" : "stageVariableOverrides",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #stageVariableOverrides(Map)}.\n@param stageVariableOverrides a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageVariableOverrides(Map)",
"deprecated" : false,
"documentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageVariableOverrides",
"fluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n@param stageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageVariableOverrides",
"getterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageVariableOverrides",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageVariableOverrides",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "StageVariableOverrides",
"sensitive" : false,
"setterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n@param stageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.",
"setterMethodName" : "setStageVariableOverrides",
"setterModel" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "stageVariableOverrides",
"variableType" : "java.util.Map",
"documentation" : null,
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.Map",
"variableName" : "stageVariableOverrides",
"variableType" : "java.util.Map",
"documentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
",
"simpleType" : "Map",
"variableSetterType" : "java.util.Map"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UseStageCache" : {
"beanStyleGetterMethodName" : "getUseStageCache",
"beanStyleSetterMethodName" : "setUseStageCache",
"c2jName" : "useStageCache",
"c2jShape" : "Boolean",
"defaultConsumerFluentSetterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\nThis is a convenience that creates an instance of the {@link Boolean.Builder} avoiding the need to create one manually via {@link Boolean#builder()}.\n\nWhen the {@link Consumer} completes, {@link Boolean.Builder#build()} is called immediately and its result is passed to {@link #useStageCache(Boolean)}.\n@param useStageCache a consumer that will call methods on {@link Boolean.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #useStageCache(Boolean)",
"deprecated" : false,
"documentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "useStageCache",
"fluentSetterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@param useStageCache A Boolean flag to indicate whether the canary deployment uses the stage cache or not.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "useStageCache",
"getterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@return A Boolean flag to indicate whether the canary deployment uses the stage cache or not.",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "useStageCache",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "useStageCache",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "BOOLEAN",
"name" : "UseStageCache",
"sensitive" : false,
"setterDocumentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
\n@param useStageCache A Boolean flag to indicate whether the canary deployment uses the stage cache or not.",
"setterMethodName" : "setUseStageCache",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "useStageCache",
"variableType" : "Boolean",
"documentation" : null,
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "useStageCache",
"variableType" : "Boolean",
"documentation" : "A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getPercentTraffic",
"beanStyleSetterMethodName" : "setPercentTraffic",
"c2jName" : "percentTraffic",
"c2jShape" : "Double",
"defaultConsumerFluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\nThis is a convenience that creates an instance of the {@link Double.Builder} avoiding the need to create one manually via {@link Double#builder()}.\n\nWhen the {@link Consumer} completes, {@link Double.Builder#build()} is called immediately and its result is passed to {@link #percentTraffic(Double)}.\n@param percentTraffic a consumer that will call methods on {@link Double.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #percentTraffic(Double)",
"deprecated" : false,
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "percentTraffic",
"fluentSetterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "percentTraffic",
"getterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@return The percent (0-100) of traffic diverted to a canary deployment.",
"getterModel" : {
"returnType" : "Double",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "percentTraffic",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "percentTraffic",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "DOUBLE",
"name" : "PercentTraffic",
"sensitive" : false,
"setterDocumentation" : "The percent (0-100) of traffic diverted to a canary deployment.
\n@param percentTraffic The percent (0-100) of traffic diverted to a canary deployment.",
"setterMethodName" : "setPercentTraffic",
"setterModel" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : null,
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Double",
"variableName" : "percentTraffic",
"variableType" : "Double",
"documentation" : "The percent (0-100) of traffic diverted to a canary deployment.
",
"simpleType" : "Double",
"variableSetterType" : "Double"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getDeploymentId",
"beanStyleSetterMethodName" : "setDeploymentId",
"c2jName" : "deploymentId",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "The ID of the canary deployment.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #deploymentId(String)}.\n@param deploymentId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #deploymentId(String)",
"deprecated" : false,
"documentation" : "The ID of the canary deployment.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "deploymentId",
"fluentSetterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "deploymentId",
"getterDocumentation" : "The ID of the canary deployment.
\n@return The ID of the canary deployment.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "deploymentId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "deploymentId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "DeploymentId",
"sensitive" : false,
"setterDocumentation" : "The ID of the canary deployment.
\n@param deploymentId The ID of the canary deployment.",
"setterMethodName" : "setDeploymentId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "deploymentId",
"variableType" : "String",
"documentation" : "The ID of the canary deployment.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getStageVariableOverrides",
"beanStyleSetterMethodName" : "setStageVariableOverrides",
"c2jName" : "stageVariableOverrides",
"c2jShape" : "MapOfStringToString",
"defaultConsumerFluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\nThis is a convenience that creates an instance of the {@link Map.Builder} avoiding the need to create one manually via {@link Map#builder()}.\n\nWhen the {@link Consumer} completes, {@link Map.Builder#build()} is called immediately and its result is passed to {@link #stageVariableOverrides(Map)}.\n@param stageVariableOverrides a consumer that will call methods on {@link Map.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #stageVariableOverrides(Map)",
"deprecated" : false,
"documentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "stageVariableOverrides",
"fluentSetterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n@param stageVariableOverrides Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "stageVariableOverrides",
"getterDocumentation" : "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n@return Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.",
"getterModel" : {
"returnType" : "java.util.Map",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "stageVariableOverrides",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "stageVariableOverrides",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : true,
"mapModel" : {
"implType" : "java.util.HashMap",
"interfaceType" : "java.util.Map",
"keyLocationName" : "key",
"keyModel" : {
"beanStyleGetterMethodName" : "getKey",
"beanStyleSetterMethodName" : "setKey",
"c2jName" : "key",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #key(String)}.\n@param key a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #key(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "key",
"fluentSetterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "key",
"getterDocumentation" : "Returns the value of the Key property for this object.\n@return The value of the Key property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "key",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "key",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Key",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Key property for this object.\n\n@param key The new value for the Key property for this object.",
"setterMethodName" : "setKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "key",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"valueLocationName" : "value",
"valueModel" : {
"beanStyleGetterMethodName" : "getValue",
"beanStyleSetterMethodName" : "setValue",
"c2jName" : "value",
"c2jShape" : "String",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #value(String)}.\n@param value a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #value(String)",
"deprecated" : false,
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "value",
"fluentSetterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "value",
"getterDocumentation" : "Returns the value of the Value property for this object.\n@return The value of the Value property for this object.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "value",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "value",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Value",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Value property for this object.\n\n@param value The new value for the Value property for this object.",
"setterMethodName" : "setValue",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "value",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"entryType" : "Map.Entry",
"templateType" : "java.util.Map"
},
"marshallingType" : "MAP",
"name" : "StageVariableOverrides",
"sensitive" : false,
"setterDocumentation" : "