libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.Lens

Contents

Description

 
Synopsis

Operations

GetResource

getResource_embed :: Lens' GetResource (Maybe [Text]) Source #

A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.

getResource_restApiId :: Lens' GetResource Text Source #

Required
The string identifier of the associated RestApi.

getResource_resourceId :: Lens' GetResource Text Source #

Required
The identifier for the Resource resource.

resource_pathPart :: Lens' Resource (Maybe Text) Source #

The last path segment for this resource.

resource_path :: Lens' Resource (Maybe Text) Source #

The full path for this resource.

resource_id :: Lens' Resource (Maybe Text) Source #

The resource's identifier.

resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method)) Source #

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "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" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

resource_parentId :: Lens' Resource (Maybe Text) Source #

The parent resource's identifier.

GetDeployments

getDeployments_limit :: Lens' GetDeployments (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDeployments_position :: Lens' GetDeployments (Maybe Text) Source #

The current pagination position in the paged result set.

getDeployments_restApiId :: Lens' GetDeployments Text Source #

Required
The string identifier of the associated RestApi.

getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment]) Source #

The current page of elements from this collection.

getDeploymentsResponse_position :: Lens' GetDeploymentsResponse (Maybe Text) Source #

Undocumented member.

getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int Source #

The response's http status code.

GetDeployment

getDeployment_embed :: Lens' GetDeployment (Maybe [Text]) Source #

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

getDeployment_restApiId :: Lens' GetDeployment Text Source #

Required
The string identifier of the associated RestApi.

getDeployment_deploymentId :: Lens' GetDeployment Text Source #

Required
The identifier of the Deployment resource to get information about.

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

GetTags

getTags_limit :: Lens' GetTags (Maybe Int) Source #

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getTags_position :: Lens' GetTags (Maybe Text) Source #

(Not currently supported) The current pagination position in the paged result set.

getTags_resourceArn :: Lens' GetTags Text Source #

Required
The ARN of a resource that can be tagged.

getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

getTagsResponse_httpStatus :: Lens' GetTagsResponse Int Source #

The response's http status code.

DeleteGatewayResponse

deleteGatewayResponse_restApiId :: Lens' DeleteGatewayResponse Text Source #

Required
The string identifier of the associated RestApi.

deleteGatewayResponse_responseType :: Lens' DeleteGatewayResponse GatewayResponseType Source #

Required

The response type of the associated GatewayResponse.

UpdateGatewayResponse

updateGatewayResponse_patchOperations :: Lens' UpdateGatewayResponse (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateGatewayResponse_restApiId :: Lens' UpdateGatewayResponse Text Source #

Required
The string identifier of the associated RestApi.

updateGatewayResponse_responseType :: Lens' UpdateGatewayResponse GatewayResponseType Source #

Required

The response type of the associated GatewayResponse.

gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse.

gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse.

gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

CreateUsagePlan

createUsagePlan_apiStages :: Lens' CreateUsagePlan (Maybe [ApiStage]) Source #

The associated API stages of the usage plan.

createUsagePlan_throttle :: Lens' CreateUsagePlan (Maybe ThrottleSettings) Source #

The throttling limits of the usage plan.

createUsagePlan_quota :: Lens' CreateUsagePlan (Maybe QuotaSettings) Source #

The quota of the usage plan.

createUsagePlan_description :: Lens' CreateUsagePlan (Maybe Text) Source #

The description of the usage plan.

createUsagePlan_tags :: Lens' CreateUsagePlan (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createUsagePlan_name :: Lens' CreateUsagePlan Text Source #

Required
The name of the usage plan.

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

The request throttle limits of a usage plan.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The maximum number of permitted requests per a given unit time interval.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetDomainNames

getDomainNames_limit :: Lens' GetDomainNames (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDomainNames_position :: Lens' GetDomainNames (Maybe Text) Source #

The current pagination position in the paged result set.

getDomainNamesResponse_items :: Lens' GetDomainNamesResponse (Maybe [DomainName]) Source #

The current page of elements from this collection.

getDomainNamesResponse_position :: Lens' GetDomainNamesResponse (Maybe Text) Source #

Undocumented member.

getDomainNamesResponse_httpStatus :: Lens' GetDomainNamesResponse Int Source #

The response's http status code.

GetClientCertificate

getClientCertificate_clientCertificateId :: Lens' GetClientCertificate Text Source #

Required
The identifier of the ClientCertificate resource to be described.

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

PutGatewayResponse

putGatewayResponse_responseTemplates :: Lens' PutGatewayResponse (Maybe (HashMap Text Text)) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

putGatewayResponse_statusCode :: Lens' PutGatewayResponse (Maybe Text) Source #

The HTTP status code of the GatewayResponse.

putGatewayResponse_responseParameters :: Lens' PutGatewayResponse (Maybe (HashMap Text Text)) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

putGatewayResponse_restApiId :: Lens' PutGatewayResponse Text Source #

Required
The string identifier of the associated RestApi.

putGatewayResponse_responseType :: Lens' PutGatewayResponse GatewayResponseType Source #

Required

The response type of the associated GatewayResponse.

gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse.

gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse.

gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

GetSdkType

getSdkType_id :: Lens' GetSdkType Text Source #

Required
The identifier of the queried SdkType instance.

sdkType_friendlyName :: Lens' SdkType (Maybe Text) Source #

The user-friendly name of an SdkType instance.

sdkType_configurationProperties :: Lens' SdkType (Maybe [SdkConfigurationProperty]) Source #

A list of configuration properties of an SdkType.

sdkType_id :: Lens' SdkType (Maybe Text) Source #

The identifier of an SdkType instance.

sdkType_description :: Lens' SdkType (Maybe Text) Source #

The description of an SdkType.

GetMethodResponse

getMethodResponse_restApiId :: Lens' GetMethodResponse Text Source #

Required
The string identifier of the associated RestApi.

getMethodResponse_resourceId :: Lens' GetMethodResponse Text Source #

Required
The Resource identifier for the MethodResponse resource.

getMethodResponse_httpMethod :: Lens' GetMethodResponse Text Source #

Required
The HTTP verb of the Method resource.

getMethodResponse_statusCode :: Lens' GetMethodResponse Text Source #

Required
The status code for the MethodResponse resource.

methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #

The method response's status code.

methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

GetModels

getModels_limit :: Lens' GetModels (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getModels_position :: Lens' GetModels (Maybe Text) Source #

The current pagination position in the paged result set.

getModels_restApiId :: Lens' GetModels Text Source #

Required
The string identifier of the associated RestApi.

getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model]) Source #

The current page of elements from this collection.

getModelsResponse_position :: Lens' GetModelsResponse (Maybe Text) Source #

Undocumented member.

getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #

The response's http status code.

GetBasePathMapping

getBasePathMapping_domainName :: Lens' GetBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to be described.

getBasePathMapping_basePath :: Lens' GetBasePathMapping Text Source #

Required
The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name.

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.

GetRequestValidators

getRequestValidators_limit :: Lens' GetRequestValidators (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getRequestValidators_position :: Lens' GetRequestValidators (Maybe Text) Source #

The current pagination position in the paged result set.

getRequestValidators_restApiId :: Lens' GetRequestValidators Text Source #

Required
The string identifier of the associated RestApi.

getRequestValidatorsResponse_items :: Lens' GetRequestValidatorsResponse (Maybe [RequestValidator]) Source #

The current page of elements from this collection.

getRequestValidatorsResponse_position :: Lens' GetRequestValidatorsResponse (Maybe Text) Source #

Undocumented member.

getRequestValidatorsResponse_httpStatus :: Lens' GetRequestValidatorsResponse Int Source #

The response's http status code.

PutMethodResponse

putMethodResponse_responseModels :: Lens' PutMethodResponse (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

putMethodResponse_responseParameters :: Lens' PutMethodResponse (Maybe (HashMap Text Bool)) Source #

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

putMethodResponse_restApiId :: Lens' PutMethodResponse Text Source #

Required
The string identifier of the associated RestApi.

putMethodResponse_resourceId :: Lens' PutMethodResponse Text Source #

Required
The Resource identifier for the Method resource.

putMethodResponse_httpMethod :: Lens' PutMethodResponse Text Source #

Required
The HTTP verb of the Method resource.

putMethodResponse_statusCode :: Lens' PutMethodResponse Text Source #

Required
The method response's status code.

methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #

The method response's status code.

methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

ImportRestApi

importRestApi_failOnWarnings :: Lens' ImportRestApi (Maybe Bool) Source #

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

importRestApi_parameters :: Lens' ImportRestApi (Maybe (HashMap Text Text)) Source #

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'

importRestApi_body :: Lens' ImportRestApi ByteString Source #

Required
The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteMethodResponse

deleteMethodResponse_restApiId :: Lens' DeleteMethodResponse Text Source #

Required
The string identifier of the associated RestApi.

deleteMethodResponse_resourceId :: Lens' DeleteMethodResponse Text Source #

Required
The Resource identifier for the MethodResponse resource.

deleteMethodResponse_httpMethod :: Lens' DeleteMethodResponse Text Source #

Required
The HTTP verb of the Method resource.

deleteMethodResponse_statusCode :: Lens' DeleteMethodResponse Text Source #

Required
The status code identifier for the MethodResponse resource.

UpdateMethodResponse

updateMethodResponse_patchOperations :: Lens' UpdateMethodResponse (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateMethodResponse_restApiId :: Lens' UpdateMethodResponse Text Source #

Required
The string identifier of the associated RestApi.

updateMethodResponse_resourceId :: Lens' UpdateMethodResponse Text Source #

Required
The Resource identifier for the MethodResponse resource.

updateMethodResponse_httpMethod :: Lens' UpdateMethodResponse Text Source #

Required
The HTTP verb of the Method resource.

updateMethodResponse_statusCode :: Lens' UpdateMethodResponse Text Source #

Required
The status code for the MethodResponse resource.

methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #

The method response's status code.

methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

DeleteStage

deleteStage_restApiId :: Lens' DeleteStage Text Source #

Required
The string identifier of the associated RestApi.

deleteStage_stageName :: Lens' DeleteStage Text Source #

Required
The name of the Stage resource to delete.

UpdateStage

updateStage_patchOperations :: Lens' UpdateStage (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateStage_restApiId :: Lens' UpdateStage Text Source #

Required
The string identifier of the associated RestApi.

updateStage_stageName :: Lens' UpdateStage Text Source #

Required
The name of the Stage resource to change information about.

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the stage points to.

stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_documentationVersion :: Lens' Stage (Maybe Text) Source #

The version of the associated API documentation.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for an API stage.

stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #

The status of the cache cluster for the stage, if enabled.

stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage last updated.

stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #

The size of the cache cluster for the stage, if enabled.

stage_webAclArn :: Lens' Stage (Maybe Text) Source #

The ARN of the WebAcl associated with the Stage.

stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #

Settings for the canary deployment in this stage.

stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether a cache cluster is enabled for the stage.

stage_stageName :: Lens' Stage (Maybe Text) Source #

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

stage_description :: Lens' Stage (Maybe Text) Source #

The stage's description.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetRestApis

getRestApis_limit :: Lens' GetRestApis (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getRestApis_position :: Lens' GetRestApis (Maybe Text) Source #

The current pagination position in the paged result set.

getRestApisResponse_items :: Lens' GetRestApisResponse (Maybe [RestApi]) Source #

The current page of elements from this collection.

getRestApisResponse_position :: Lens' GetRestApisResponse (Maybe Text) Source #

Undocumented member.

getRestApisResponse_httpStatus :: Lens' GetRestApisResponse Int Source #

The response's http status code.

GetDocumentationVersions

getDocumentationVersions_limit :: Lens' GetDocumentationVersions (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDocumentationVersions_position :: Lens' GetDocumentationVersions (Maybe Text) Source #

The current pagination position in the paged result set.

getDocumentationVersions_restApiId :: Lens' GetDocumentationVersions Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationVersionsResponse_items :: Lens' GetDocumentationVersionsResponse (Maybe [DocumentationVersion]) Source #

The current page of elements from this collection.

getDocumentationVersionsResponse_position :: Lens' GetDocumentationVersionsResponse (Maybe Text) Source #

Undocumented member.

getDocumentationVersionsResponse_httpStatus :: Lens' GetDocumentationVersionsResponse Int Source #

The response's http status code.

CreateDeployment

createDeployment_stageDescription :: Lens' CreateDeployment (Maybe Text) Source #

The description of the Stage resource for the Deployment resource to create.

createDeployment_variables :: Lens' CreateDeployment (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

createDeployment_tracingEnabled :: Lens' CreateDeployment (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

createDeployment_cacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize) Source #

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

createDeployment_canarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings) Source #

The input configuration for the canary deployment when the deployment is a canary release deployment.

createDeployment_cacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool) Source #

Enables a cache cluster for the Stage resource specified in the input.

createDeployment_stageName :: Lens' CreateDeployment (Maybe Text) Source #

The name of the Stage resource for the Deployment resource to create.

createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #

The description for the Deployment resource to create.

createDeployment_restApiId :: Lens' CreateDeployment Text Source #

Required
The string identifier of the associated RestApi.

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

GetVpcLinks

getVpcLinks_limit :: Lens' GetVpcLinks (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getVpcLinks_position :: Lens' GetVpcLinks (Maybe Text) Source #

The current pagination position in the paged result set.

getVpcLinksResponse_items :: Lens' GetVpcLinksResponse (Maybe [VpcLink]) Source #

The current page of elements from this collection.

getVpcLinksResponse_position :: Lens' GetVpcLinksResponse (Maybe Text) Source #

Undocumented member.

getVpcLinksResponse_httpStatus :: Lens' GetVpcLinksResponse Int Source #

The response's http status code.

CreateBasePathMapping

createBasePathMapping_stage :: Lens' CreateBasePathMapping (Maybe Text) Source #

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

createBasePathMapping_basePath :: Lens' CreateBasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

createBasePathMapping_domainName :: Lens' CreateBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to create.

createBasePathMapping_restApiId :: Lens' CreateBasePathMapping Text Source #

Required
The string identifier of the associated RestApi.

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name.

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.

GetIntegration

getIntegration_restApiId :: Lens' GetIntegration Text Source #

Required
The string identifier of the associated RestApi.

getIntegration_resourceId :: Lens' GetIntegration Text Source #

Required
Specifies a get integration request's resource identifier

getIntegration_httpMethod :: Lens' GetIntegration Text Source #

Required
Specifies a get integration request's HTTP method.

integration_httpMethod :: Lens' Integration (Maybe Text) Source #

Specifies the integration's HTTP method type.

integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

integration_credentials :: Lens' Integration (Maybe Text) Source #

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

integration_connectionId :: Lens' Integration (Maybe Text) Source #

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

integration_passthroughBehavior :: Lens' Integration (Maybe Text) Source #

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

integration_uri :: Lens' Integration (Maybe Text) Source #

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/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-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #

Specifies the TLS configuration for an integration.

integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

integration_type :: Lens' Integration (Maybe IntegrationType) Source #

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

GetDocumentationParts

getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text) Source #

The path of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_locationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType) Source #

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

getDocumentationParts_nameQuery :: Lens' GetDocumentationParts (Maybe Text) Source #

The name of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_limit :: Lens' GetDocumentationParts (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getDocumentationParts_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType) Source #

The type of API entities of the to-be-retrieved documentation parts.

getDocumentationParts_position :: Lens' GetDocumentationParts (Maybe Text) Source #

The current pagination position in the paged result set.

getDocumentationParts_restApiId :: Lens' GetDocumentationParts Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationPartsResponse_items :: Lens' GetDocumentationPartsResponse (Maybe [DocumentationPart]) Source #

The current page of elements from this collection.

getDocumentationPartsResponse_position :: Lens' GetDocumentationPartsResponse (Maybe Text) Source #

Undocumented member.

getDocumentationPartsResponse_httpStatus :: Lens' GetDocumentationPartsResponse Int Source #

The response's http status code.

UpdateAccount

updateAccount_patchOperations :: Lens' UpdateAccount (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

account_apiKeyVersion :: Lens' Account (Maybe Text) Source #

The version of the API keys used for the account.

account_cloudwatchRoleArn :: Lens' Account (Maybe Text) Source #

The ARN of an Amazon CloudWatch role for the current Account.

account_features :: Lens' Account (Maybe [Text]) Source #

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

account_throttleSettings :: Lens' Account (Maybe ThrottleSettings) Source #

Specifies the API request limits configured for the current Account.

GetUsagePlan

getUsagePlan_usagePlanId :: Lens' GetUsagePlan Text Source #

Required
The identifier of the UsagePlan resource to be retrieved.

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

The request throttle limits of a usage plan.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The maximum number of permitted requests per a given unit time interval.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteDeployment

deleteDeployment_restApiId :: Lens' DeleteDeployment Text Source #

Required
The string identifier of the associated RestApi.

deleteDeployment_deploymentId :: Lens' DeleteDeployment Text Source #

Required
The identifier of the Deployment resource to delete.

UpdateDeployment

updateDeployment_patchOperations :: Lens' UpdateDeployment (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDeployment_restApiId :: Lens' UpdateDeployment Text Source #

Required
The string identifier of the associated RestApi.

updateDeployment_deploymentId :: Lens' UpdateDeployment Text Source #

The replacement identifier for the Deployment resource to change information about.

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

GetDocumentationPart

getDocumentationPart_restApiId :: Lens' GetDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationPart_documentationPartId :: Lens' GetDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

DeleteResource

deleteResource_restApiId :: Lens' DeleteResource Text Source #

Required
The string identifier of the associated RestApi.

deleteResource_resourceId :: Lens' DeleteResource Text Source #

Required
The identifier of the Resource resource.

UpdateResource

updateResource_patchOperations :: Lens' UpdateResource (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateResource_restApiId :: Lens' UpdateResource Text Source #

Required
The string identifier of the associated RestApi.

updateResource_resourceId :: Lens' UpdateResource Text Source #

Required
The identifier of the Resource resource.

resource_pathPart :: Lens' Resource (Maybe Text) Source #

The last path segment for this resource.

resource_path :: Lens' Resource (Maybe Text) Source #

The full path for this resource.

resource_id :: Lens' Resource (Maybe Text) Source #

The resource's identifier.

resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method)) Source #

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "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" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

resource_parentId :: Lens' Resource (Maybe Text) Source #

The parent resource's identifier.

CreateRequestValidator

createRequestValidator_validateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request parameters, true, or not false.

createRequestValidator_name :: Lens' CreateRequestValidator (Maybe Text) Source #

The name of the to-be-created RequestValidator.

createRequestValidator_validateRequestBody :: Lens' CreateRequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

createRequestValidator_restApiId :: Lens' CreateRequestValidator Text Source #

Required
The string identifier of the associated RestApi.

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #

The identifier of this RequestValidator.

ImportDocumentationParts

importDocumentationParts_mode :: Lens' ImportDocumentationParts (Maybe PutMode) Source #

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

importDocumentationParts_failOnWarnings :: Lens' ImportDocumentationParts (Maybe Bool) Source #

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

importDocumentationParts_restApiId :: Lens' ImportDocumentationParts Text Source #

Required
The string identifier of the associated RestApi.

importDocumentationParts_body :: Lens' ImportDocumentationParts ByteString Source #

Required
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

importDocumentationPartsResponse_ids :: Lens' ImportDocumentationPartsResponse (Maybe [Text]) Source #

A list of the returned documentation part identifiers.

importDocumentationPartsResponse_warnings :: Lens' ImportDocumentationPartsResponse (Maybe [Text]) Source #

A list of warning messages reported during import of documentation parts.

importDocumentationPartsResponse_httpStatus :: Lens' ImportDocumentationPartsResponse Int Source #

The response's http status code.

GetUsage

getUsage_keyId :: Lens' GetUsage (Maybe Text) Source #

The Id of the API key associated with the resultant usage data.

getUsage_limit :: Lens' GetUsage (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getUsage_position :: Lens' GetUsage (Maybe Text) Source #

The current pagination position in the paged result set.

getUsage_usagePlanId :: Lens' GetUsage Text Source #

Required
The Id of the usage plan associated with the usage data.

getUsage_startDate :: Lens' GetUsage Text Source #

Required
The starting date (e.g., 2016-01-01) of the usage data.

getUsage_endDate :: Lens' GetUsage Text Source #

Required
The ending date (e.g., 2016-12-31) of the usage data.

usage_usagePlanId :: Lens' Usage (Maybe Text) Source #

The plan Id associated with this usage data.

usage_endDate :: Lens' Usage (Maybe Text) Source #

The ending date of the usage data.

usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]])) Source #

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

usage_startDate :: Lens' Usage (Maybe Text) Source #

The starting date of the usage data.

usage_position :: Lens' Usage (Maybe Text) Source #

Undocumented member.

GetVpcLink

getVpcLink_vpcLinkId :: Lens' GetVpcLink Text Source #

Required
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

vpcLink_targetArns :: Lens' VpcLink (Maybe [Text]) Source #

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

vpcLink_name :: Lens' VpcLink (Maybe Text) Source #

The name used to label and identify the VPC link.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #

A description about the VPC link status.

vpcLink_id :: Lens' VpcLink (Maybe Text) Source #

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_description :: Lens' VpcLink (Maybe Text) Source #

The description of the VPC link.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

CreateModel

createModel_schema :: Lens' CreateModel (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model.

createModel_description :: Lens' CreateModel (Maybe Text) Source #

The description of the model.

createModel_restApiId :: Lens' CreateModel Text Source #

Required
The RestApi identifier under which the Model will be created.

createModel_name :: Lens' CreateModel Text Source #

Required
The name of the model. Must be alphanumeric.

createModel_contentType :: Lens' CreateModel Text Source #

Required
The content-type for the model.

model_schema :: Lens' Model (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

model_name :: Lens' Model (Maybe Text) Source #

The name of the model. Must be an alphanumeric string.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

GetIntegrationResponse

getIntegrationResponse_restApiId :: Lens' GetIntegrationResponse Text Source #

Required
The string identifier of the associated RestApi.

getIntegrationResponse_resourceId :: Lens' GetIntegrationResponse Text Source #

Required
Specifies a get integration response request's resource identifier.

getIntegrationResponse_httpMethod :: Lens' GetIntegrationResponse Text Source #

Required
Specifies a get integration response request's HTTP method.

getIntegrationResponse_statusCode :: Lens' GetIntegrationResponse Text Source #

Required
Specifies a get integration response request's status code.

integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse.

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

CreateDomainName

createDomainName_certificateName :: Lens' CreateDomainName (Maybe Text) Source #

The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

createDomainName_ownershipVerificationCertificateArn :: Lens' CreateDomainName (Maybe Text) Source #

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

createDomainName_regionalCertificateArn :: Lens' CreateDomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

createDomainName_certificateArn :: Lens' CreateDomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

createDomainName_securityPolicy :: Lens' CreateDomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

createDomainName_mutualTlsAuthentication :: Lens' CreateDomainName (Maybe MutualTlsAuthenticationInput) Source #

Undocumented member.

createDomainName_certificatePrivateKey :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
Your edge-optimized endpoint's domain name certificate's private key.

createDomainName_regionalCertificateName :: Lens' CreateDomainName (Maybe Text) Source #

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

createDomainName_certificateBody :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

createDomainName_certificateChain :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

createDomainName_endpointConfiguration :: Lens' CreateDomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

createDomainName_tags :: Lens' CreateDomainName (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createDomainName_domainName :: Lens' CreateDomainName Text Source #

Required
The name of the DomainName resource.

domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_certificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

domainName_certificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_domainName :: Lens' DomainName (Maybe Text) Source #

The custom domain name as an API host name, for example, my-api.example.com.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used for validating the regional domain name.

domainName_regionalDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainName_distributionDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #

The status of the DomainName migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

FlushStageAuthorizersCache

flushStageAuthorizersCache_restApiId :: Lens' FlushStageAuthorizersCache Text Source #

The string identifier of the associated RestApi.

flushStageAuthorizersCache_stageName :: Lens' FlushStageAuthorizersCache Text Source #

The name of the stage to flush.

GetGatewayResponses

getGatewayResponses_limit :: Lens' GetGatewayResponses (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

getGatewayResponses_position :: Lens' GetGatewayResponses (Maybe Text) Source #

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

getGatewayResponses_restApiId :: Lens' GetGatewayResponses Text Source #

Required
The string identifier of the associated RestApi.

getGatewayResponsesResponse_items :: Lens' GetGatewayResponsesResponse (Maybe [GatewayResponse]) Source #

Returns the entire collection, because of no pagination support.

getGatewayResponsesResponse_position :: Lens' GetGatewayResponsesResponse (Maybe Text) Source #

Undocumented member.

getGatewayResponsesResponse_httpStatus :: Lens' GetGatewayResponsesResponse Int Source #

The response's http status code.

DeleteModel

deleteModel_restApiId :: Lens' DeleteModel Text Source #

Required
The string identifier of the associated RestApi.

deleteModel_modelName :: Lens' DeleteModel Text Source #

Required
The name of the model to delete.

UpdateModel

updateModel_patchOperations :: Lens' UpdateModel (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateModel_restApiId :: Lens' UpdateModel Text Source #

Required
The string identifier of the associated RestApi.

updateModel_modelName :: Lens' UpdateModel Text Source #

Required
The name of the model to update.

model_schema :: Lens' Model (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

model_name :: Lens' Model (Maybe Text) Source #

The name of the model. Must be an alphanumeric string.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

GetDocumentationVersion

getDocumentationVersion_restApiId :: Lens' GetDocumentationVersion Text Source #

Required
The string identifier of the associated RestApi.

getDocumentationVersion_documentationVersion :: Lens' GetDocumentationVersion Text Source #

Required
The version identifier of the to-be-retrieved documentation snapshot.

documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.

DeleteApiKey

deleteApiKey_apiKey :: Lens' DeleteApiKey Text Source #

Required
The identifier of the ApiKey resource to be deleted.

UpdateApiKey

updateApiKey_patchOperations :: Lens' UpdateApiKey (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateApiKey_apiKey :: Lens' UpdateApiKey Text Source #

Required
The identifier of the ApiKey resource to be updated.

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetRestApi

getRestApi_restApiId :: Lens' GetRestApi Text Source #

Required
The string identifier of the associated RestApi.

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetStages

getStages_deploymentId :: Lens' GetStages (Maybe Text) Source #

The stages' deployment identifiers.

getStages_restApiId :: Lens' GetStages Text Source #

Required
The string identifier of the associated RestApi.

getStagesResponse_item :: Lens' GetStagesResponse (Maybe [Stage]) Source #

The current page of elements from this collection.

getStagesResponse_httpStatus :: Lens' GetStagesResponse Int Source #

The response's http status code.

PutRestApi

putRestApi_mode :: Lens' PutRestApi (Maybe PutMode) Source #

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

putRestApi_failOnWarnings :: Lens' PutRestApi (Maybe Bool) Source #

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

putRestApi_parameters :: Lens' PutRestApi (Maybe (HashMap Text Text)) Source #

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

putRestApi_restApiId :: Lens' PutRestApi Text Source #

Required
The string identifier of the associated RestApi.

putRestApi_body :: Lens' PutRestApi ByteString Source #

Required
The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetMethod

getMethod_restApiId :: Lens' GetMethod Text Source #

Required
The string identifier of the associated RestApi.

getMethod_resourceId :: Lens' GetMethod Text Source #

Required
The Resource identifier for the Method resource.

getMethod_httpMethod :: Lens' GetMethod Text Source #

Required
Specifies the method request's HTTP method type.

method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI

method_httpMethod :: Lens' Method (Maybe Text) Source #

The method's HTTP verb.

method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

method_requestValidatorId :: Lens' Method (Maybe Text) Source #

The identifier of a RequestValidator for request validation.

method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

method_authorizerId :: Lens' Method (Maybe Text) Source #

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

method_operationName :: Lens' Method (Maybe Text) Source #

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

method_authorizationType :: Lens' Method (Maybe Text) Source #

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

method_methodIntegration :: Lens' Method (Maybe Integration) Source #

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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 } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI

GetModel

getModel_flatten :: Lens' GetModel (Maybe Bool) Source #

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

getModel_restApiId :: Lens' GetModel Text Source #

Required
The RestApi identifier under which the Model exists.

getModel_modelName :: Lens' GetModel Text Source #

Required
The name of the model as an identifier.

model_schema :: Lens' Model (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

model_name :: Lens' Model (Maybe Text) Source #

The name of the model. Must be an alphanumeric string.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

UpdateRestApi

updateRestApi_patchOperations :: Lens' UpdateRestApi (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateRestApi_restApiId :: Lens' UpdateRestApi Text Source #

Required
The string identifier of the associated RestApi.

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteRestApi

deleteRestApi_restApiId :: Lens' DeleteRestApi Text Source #

Required
The string identifier of the associated RestApi.

ImportApiKeys

importApiKeys_failOnWarnings :: Lens' ImportApiKeys (Maybe Bool) Source #

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

importApiKeys_body :: Lens' ImportApiKeys ByteString Source #

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

importApiKeys_format :: Lens' ImportApiKeys ApiKeysFormat Source #

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

importApiKeysResponse_ids :: Lens' ImportApiKeysResponse (Maybe [Text]) Source #

A list of all the ApiKey identifiers.

importApiKeysResponse_warnings :: Lens' ImportApiKeysResponse (Maybe [Text]) Source #

A list of warning messages.

importApiKeysResponse_httpStatus :: Lens' ImportApiKeysResponse Int Source #

The response's http status code.

CreateDocumentationPart

createDocumentationPart_restApiId :: Lens' CreateDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

createDocumentationPart_location :: Lens' CreateDocumentationPart DocumentationPartLocation Source #

Required
The location of the targeted API entity of the to-be-created documentation part.

createDocumentationPart_properties :: Lens' CreateDocumentationPart Text Source #

Required
The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

TestInvokeMethod

testInvokeMethod_pathWithQueryString :: Lens' TestInvokeMethod (Maybe Text) Source #

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

testInvokeMethod_body :: Lens' TestInvokeMethod (Maybe Text) Source #

The simulated request body of an incoming invocation request.

testInvokeMethod_clientCertificateId :: Lens' TestInvokeMethod (Maybe Text) Source #

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

testInvokeMethod_stageVariables :: Lens' TestInvokeMethod (Maybe (HashMap Text Text)) Source #

A key-value map of stage variables to simulate an invocation on a deployed Stage.

testInvokeMethod_headers :: Lens' TestInvokeMethod (Maybe (HashMap Text Text)) Source #

A key-value map of headers to simulate an incoming invocation request.

testInvokeMethod_multiValueHeaders :: Lens' TestInvokeMethod (Maybe (HashMap Text [Text])) Source #

The headers as a map from string to list of values to simulate an incoming invocation request.

testInvokeMethod_restApiId :: Lens' TestInvokeMethod Text Source #

Required
The string identifier of the associated RestApi.

testInvokeMethod_resourceId :: Lens' TestInvokeMethod Text Source #

Required
Specifies a test invoke method request's resource ID.

testInvokeMethod_httpMethod :: Lens' TestInvokeMethod Text Source #

Required
Specifies a test invoke method request's HTTP method.

testInvokeMethodResponse_log :: Lens' TestInvokeMethodResponse (Maybe Text) Source #

The API Gateway execution log for the test invoke request.

testInvokeMethodResponse_status :: Lens' TestInvokeMethodResponse (Maybe Int) Source #

The HTTP status code.

testInvokeMethodResponse_body :: Lens' TestInvokeMethodResponse (Maybe Text) Source #

The body of the HTTP response.

testInvokeMethodResponse_latency :: Lens' TestInvokeMethodResponse (Maybe Integer) Source #

The execution latency of the test invoke request.

testInvokeMethodResponse_headers :: Lens' TestInvokeMethodResponse (Maybe (HashMap Text Text)) Source #

The headers of the HTTP response.

testInvokeMethodResponse_multiValueHeaders :: Lens' TestInvokeMethodResponse (Maybe (HashMap Text [Text])) Source #

The headers of the HTTP response as a map from string to list of values.

testInvokeMethodResponse_httpStatus :: Lens' TestInvokeMethodResponse Int Source #

The response's http status code.

GetRequestValidator

getRequestValidator_restApiId :: Lens' GetRequestValidator Text Source #

Required
The string identifier of the associated RestApi.

getRequestValidator_requestValidatorId :: Lens' GetRequestValidator Text Source #

Required
The identifier of the RequestValidator to be retrieved.

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #

The identifier of this RequestValidator.

GetDomainName

getDomainName_domainName :: Lens' GetDomainName Text Source #

Required
The name of the DomainName resource.

domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_certificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

domainName_certificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_domainName :: Lens' DomainName (Maybe Text) Source #

The custom domain name as an API host name, for example, my-api.example.com.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used for validating the regional domain name.

domainName_regionalDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainName_distributionDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #

The status of the DomainName migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

CreateVpcLink

createVpcLink_description :: Lens' CreateVpcLink (Maybe Text) Source #

The description of the VPC link.

createVpcLink_tags :: Lens' CreateVpcLink (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createVpcLink_name :: Lens' CreateVpcLink Text Source #

Required
The name used to label and identify the VPC link.

createVpcLink_targetArns :: Lens' CreateVpcLink [Text] Source #

Required
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

vpcLink_targetArns :: Lens' VpcLink (Maybe [Text]) Source #

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

vpcLink_name :: Lens' VpcLink (Maybe Text) Source #

The name used to label and identify the VPC link.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #

A description about the VPC link status.

vpcLink_id :: Lens' VpcLink (Maybe Text) Source #

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_description :: Lens' VpcLink (Maybe Text) Source #

The description of the VPC link.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteDocumentationPart

deleteDocumentationPart_restApiId :: Lens' DeleteDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

deleteDocumentationPart_documentationPartId :: Lens' DeleteDocumentationPart Text Source #

Required
The identifier of the to-be-deleted documentation part.

UpdateDocumentationPart

updateDocumentationPart_patchOperations :: Lens' UpdateDocumentationPart (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDocumentationPart_restApiId :: Lens' UpdateDocumentationPart Text Source #

Required
The string identifier of the associated RestApi.

updateDocumentationPart_documentationPartId :: Lens' UpdateDocumentationPart Text Source #

Required
The identifier of the to-be-updated documentation part.

documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

GetAuthorizers

getAuthorizers_limit :: Lens' GetAuthorizers (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getAuthorizers_position :: Lens' GetAuthorizers (Maybe Text) Source #

The current pagination position in the paged result set.

getAuthorizers_restApiId :: Lens' GetAuthorizers Text Source #

Required
The string identifier of the associated RestApi.

getAuthorizersResponse_items :: Lens' GetAuthorizersResponse (Maybe [Authorizer]) Source #

The current page of elements from this collection.

getAuthorizersResponse_position :: Lens' GetAuthorizersResponse (Maybe Text) Source #

Undocumented member.

getAuthorizersResponse_httpStatus :: Lens' GetAuthorizersResponse Int Source #

The response's http status code.

CreateDocumentationVersion

createDocumentationVersion_stageName :: Lens' CreateDocumentationVersion (Maybe Text) Source #

The stage name to be associated with the new documentation snapshot.

createDocumentationVersion_description :: Lens' CreateDocumentationVersion (Maybe Text) Source #

A description about the new documentation snapshot.

createDocumentationVersion_restApiId :: Lens' CreateDocumentationVersion Text Source #

Required
The string identifier of the associated RestApi.

createDocumentationVersion_documentationVersion :: Lens' CreateDocumentationVersion Text Source #

Required
The version identifier of the new snapshot.

documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.

PutIntegrationResponse

putIntegrationResponse_contentHandling :: Lens' PutIntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

putIntegrationResponse_responseTemplates :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies a put integration response's templates.

putIntegrationResponse_selectionPattern :: Lens' PutIntegrationResponse (Maybe Text) Source #

Specifies the selection pattern of a put integration response.

putIntegrationResponse_responseParameters :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

putIntegrationResponse_restApiId :: Lens' PutIntegrationResponse Text Source #

Required
The string identifier of the associated RestApi.

putIntegrationResponse_resourceId :: Lens' PutIntegrationResponse Text Source #

Required
Specifies a put integration response request's resource identifier.

putIntegrationResponse_httpMethod :: Lens' PutIntegrationResponse Text Source #

Required
Specifies a put integration response request's HTTP method.

putIntegrationResponse_statusCode :: Lens' PutIntegrationResponse Text Source #

Required
Specifies the status code that is used to map the integration response to an existing MethodResponse.

integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse.

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

GetUsagePlanKeys

getUsagePlanKeys_nameQuery :: Lens' GetUsagePlanKeys (Maybe Text) Source #

A query parameter specifying the name of the to-be-returned usage plan keys.

getUsagePlanKeys_limit :: Lens' GetUsagePlanKeys (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getUsagePlanKeys_position :: Lens' GetUsagePlanKeys (Maybe Text) Source #

The current pagination position in the paged result set.

getUsagePlanKeys_usagePlanId :: Lens' GetUsagePlanKeys Text Source #

Required
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

getUsagePlanKeysResponse_items :: Lens' GetUsagePlanKeysResponse (Maybe [UsagePlanKey]) Source #

The current page of elements from this collection.

getUsagePlanKeysResponse_position :: Lens' GetUsagePlanKeysResponse (Maybe Text) Source #

Undocumented member.

getUsagePlanKeysResponse_httpStatus :: Lens' GetUsagePlanKeysResponse Int Source #

The response's http status code.

DeleteVpcLink

deleteVpcLink_vpcLinkId :: Lens' DeleteVpcLink Text Source #

Required
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

UpdateVpcLink

updateVpcLink_patchOperations :: Lens' UpdateVpcLink (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateVpcLink_vpcLinkId :: Lens' UpdateVpcLink Text Source #

Required
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

vpcLink_targetArns :: Lens' VpcLink (Maybe [Text]) Source #

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

vpcLink_name :: Lens' VpcLink (Maybe Text) Source #

The name used to label and identify the VPC link.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #

A description about the VPC link status.

vpcLink_id :: Lens' VpcLink (Maybe Text) Source #

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_description :: Lens' VpcLink (Maybe Text) Source #

The description of the VPC link.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

FlushStageCache

flushStageCache_restApiId :: Lens' FlushStageCache Text Source #

Required
The string identifier of the associated RestApi.

flushStageCache_stageName :: Lens' FlushStageCache Text Source #

Required
The name of the stage to flush its cache.

CreateRestApi

createRestApi_minimumCompressionSize :: Lens' CreateRestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

createRestApi_disableExecuteApiEndpoint :: Lens' CreateRestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

createRestApi_binaryMediaTypes :: Lens' CreateRestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

createRestApi_version :: Lens' CreateRestApi (Maybe Text) Source #

A version identifier for the API.

createRestApi_apiKeySource :: Lens' CreateRestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

createRestApi_cloneFrom :: Lens' CreateRestApi (Maybe Text) Source #

The ID of the RestApi that you want to clone from.

createRestApi_policy :: Lens' CreateRestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

createRestApi_endpointConfiguration :: Lens' CreateRestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

createRestApi_description :: Lens' CreateRestApi (Maybe Text) Source #

The description of the RestApi.

createRestApi_tags :: Lens' CreateRestApi (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createRestApi_name :: Lens' CreateRestApi Text Source #

Required
The name of the RestApi.

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteIntegrationResponse

deleteIntegrationResponse_restApiId :: Lens' DeleteIntegrationResponse Text Source #

Required
The string identifier of the associated RestApi.

deleteIntegrationResponse_resourceId :: Lens' DeleteIntegrationResponse Text Source #

Required
Specifies a delete integration response request's resource identifier.

deleteIntegrationResponse_httpMethod :: Lens' DeleteIntegrationResponse Text Source #

Required
Specifies a delete integration response request's HTTP method.

deleteIntegrationResponse_statusCode :: Lens' DeleteIntegrationResponse Text Source #

Required
Specifies a delete integration response request's status code.

UpdateIntegrationResponse

updateIntegrationResponse_patchOperations :: Lens' UpdateIntegrationResponse (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateIntegrationResponse_restApiId :: Lens' UpdateIntegrationResponse Text Source #

Required
The string identifier of the associated RestApi.

updateIntegrationResponse_resourceId :: Lens' UpdateIntegrationResponse Text Source #

Required
Specifies an update integration response request's resource identifier.

updateIntegrationResponse_httpMethod :: Lens' UpdateIntegrationResponse Text Source #

Required
Specifies an update integration response request's HTTP method.

updateIntegrationResponse_statusCode :: Lens' UpdateIntegrationResponse Text Source #

Required
Specifies an update integration response request's status code.

integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse.

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

UpdateUsage

updateUsage_patchOperations :: Lens' UpdateUsage (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateUsage_usagePlanId :: Lens' UpdateUsage Text Source #

Required
The Id of the usage plan associated with the usage data.

updateUsage_keyId :: Lens' UpdateUsage Text Source #

Required
The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

usage_usagePlanId :: Lens' Usage (Maybe Text) Source #

The plan Id associated with this usage data.

usage_endDate :: Lens' Usage (Maybe Text) Source #

The ending date of the usage data.

usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]])) Source #

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

usage_startDate :: Lens' Usage (Maybe Text) Source #

The starting date of the usage data.

usage_position :: Lens' Usage (Maybe Text) Source #

Undocumented member.

DeleteIntegration

deleteIntegration_restApiId :: Lens' DeleteIntegration Text Source #

Required
The string identifier of the associated RestApi.

deleteIntegration_resourceId :: Lens' DeleteIntegration Text Source #

Required
Specifies a delete integration request's resource identifier.

deleteIntegration_httpMethod :: Lens' DeleteIntegration Text Source #

Required
Specifies a delete integration request's HTTP method.

UpdateIntegration

updateIntegration_patchOperations :: Lens' UpdateIntegration (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateIntegration_restApiId :: Lens' UpdateIntegration Text Source #

Required
The string identifier of the associated RestApi.

updateIntegration_resourceId :: Lens' UpdateIntegration Text Source #

Required
Represents an update integration request's resource identifier.

updateIntegration_httpMethod :: Lens' UpdateIntegration Text Source #

Required
Represents an update integration request's HTTP method.

integration_httpMethod :: Lens' Integration (Maybe Text) Source #

Specifies the integration's HTTP method type.

integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

integration_credentials :: Lens' Integration (Maybe Text) Source #

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

integration_connectionId :: Lens' Integration (Maybe Text) Source #

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

integration_passthroughBehavior :: Lens' Integration (Maybe Text) Source #

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

integration_uri :: Lens' Integration (Maybe Text) Source #

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/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-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #

Specifies the TLS configuration for an integration.

integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

integration_type :: Lens' Integration (Maybe IntegrationType) Source #

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

TestInvokeAuthorizer

testInvokeAuthorizer_pathWithQueryString :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

Optional
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

testInvokeAuthorizer_body :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

Optional
The simulated request body of an incoming invocation request.

testInvokeAuthorizer_additionalContext :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

Optional
A key-value map of additional context variables.

testInvokeAuthorizer_stageVariables :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

A key-value map of stage variables to simulate an invocation on a deployed Stage.

testInvokeAuthorizer_headers :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text Text)) Source #

Required
A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

testInvokeAuthorizer_multiValueHeaders :: Lens' TestInvokeAuthorizer (Maybe (HashMap Text [Text])) Source #

Optional
The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

testInvokeAuthorizer_restApiId :: Lens' TestInvokeAuthorizer Text Source #

Required
The string identifier of the associated RestApi.

testInvokeAuthorizer_authorizerId :: Lens' TestInvokeAuthorizer Text Source #

Required
Specifies a test invoke authorizer request's Authorizer ID.

testInvokeAuthorizerResponse_log :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The API Gateway execution log for the test authorizer request.

testInvokeAuthorizerResponse_principalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The principal identity returned by the Authorizer

testInvokeAuthorizerResponse_latency :: Lens' TestInvokeAuthorizerResponse (Maybe Integer) Source #

The execution latency of the test authorizer request.

testInvokeAuthorizerResponse_authorization :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text [Text])) Source #

Undocumented member.

testInvokeAuthorizerResponse_claims :: Lens' TestInvokeAuthorizerResponse (Maybe (HashMap Text Text)) Source #

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

testInvokeAuthorizerResponse_clientStatus :: Lens' TestInvokeAuthorizerResponse (Maybe Int) Source #

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

testInvokeAuthorizerResponse_policy :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The JSON policy document returned by the Authorizer

testInvokeAuthorizerResponse_httpStatus :: Lens' TestInvokeAuthorizerResponse Int Source #

The response's http status code.

GenerateClientCertificate

generateClientCertificate_description :: Lens' GenerateClientCertificate (Maybe Text) Source #

The description of the ClientCertificate.

generateClientCertificate_tags :: Lens' GenerateClientCertificate (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetResources

getResources_embed :: Lens' GetResources (Maybe [Text]) Source #

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

getResources_limit :: Lens' GetResources (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getResources_position :: Lens' GetResources (Maybe Text) Source #

The current pagination position in the paged result set.

getResources_restApiId :: Lens' GetResources Text Source #

Required
The string identifier of the associated RestApi.

getResourcesResponse_items :: Lens' GetResourcesResponse (Maybe [Resource]) Source #

The current page of elements from this collection.

getResourcesResponse_position :: Lens' GetResourcesResponse (Maybe Text) Source #

Undocumented member.

getResourcesResponse_httpStatus :: Lens' GetResourcesResponse Int Source #

The response's http status code.

GetUsagePlanKey

getUsagePlanKey_usagePlanId :: Lens' GetUsagePlanKey Text Source #

Required
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

getUsagePlanKey_keyId :: Lens' GetUsagePlanKey Text Source #

Required
The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text) Source #

The value of a usage plan key.

usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text) Source #

The name of a usage plan key.

usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text) Source #

The Id of a usage plan key.

usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text) Source #

The type of a usage plan key. Currently, the valid key type is API_KEY.

GetAccount

account_apiKeyVersion :: Lens' Account (Maybe Text) Source #

The version of the API keys used for the account.

account_cloudwatchRoleArn :: Lens' Account (Maybe Text) Source #

The ARN of an Amazon CloudWatch role for the current Account.

account_features :: Lens' Account (Maybe [Text]) Source #

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

account_throttleSettings :: Lens' Account (Maybe ThrottleSettings) Source #

Specifies the API request limits configured for the current Account.

PutIntegration

putIntegration_requestTemplates :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

putIntegration_credentials :: Lens' PutIntegration (Maybe Text) Source #

Specifies whether credentials are required for a put integration.

putIntegration_connectionId :: Lens' PutIntegration (Maybe Text) Source #

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

putIntegration_requestParameters :: Lens' PutIntegration (Maybe (HashMap Text Text)) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

putIntegration_contentHandling :: Lens' PutIntegration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

putIntegration_passthroughBehavior :: Lens' PutIntegration (Maybe Text) Source #

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.
  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

putIntegration_uri :: Lens' PutIntegration (Maybe Text) Source #

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

putIntegration_tlsConfig :: Lens' PutIntegration (Maybe TlsConfig) Source #

Undocumented member.

putIntegration_cacheNamespace :: Lens' PutIntegration (Maybe Text) Source #

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

putIntegration_timeoutInMillis :: Lens' PutIntegration (Maybe Int) Source #

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

putIntegration_connectionType :: Lens' PutIntegration (Maybe ConnectionType) Source #

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

putIntegration_integrationHttpMethod :: Lens' PutIntegration (Maybe Text) Source #

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

putIntegration_cacheKeyParameters :: Lens' PutIntegration (Maybe [Text]) Source #

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

putIntegration_restApiId :: Lens' PutIntegration Text Source #

Required
The string identifier of the associated RestApi.

putIntegration_resourceId :: Lens' PutIntegration Text Source #

Required
Specifies a put integration request's resource ID.

putIntegration_httpMethod :: Lens' PutIntegration Text Source #

Required
Specifies a put integration request's HTTP method.

putIntegration_type :: Lens' PutIntegration IntegrationType Source #

Required
Specifies a put integration input's type.

integration_httpMethod :: Lens' Integration (Maybe Text) Source #

Specifies the integration's HTTP method type.

integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

integration_credentials :: Lens' Integration (Maybe Text) Source #

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

integration_connectionId :: Lens' Integration (Maybe Text) Source #

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

integration_passthroughBehavior :: Lens' Integration (Maybe Text) Source #

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

integration_uri :: Lens' Integration (Maybe Text) Source #

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/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-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #

Specifies the TLS configuration for an integration.

integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

integration_type :: Lens' Integration (Maybe IntegrationType) Source #

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

GetAuthorizer

getAuthorizer_restApiId :: Lens' GetAuthorizer Text Source #

Required
The string identifier of the associated RestApi.

getAuthorizer_authorizerId :: Lens' GetAuthorizer Text Source #

Required
The identifier of the Authorizer resource.

authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #

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.

authorizer_name :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

authorizer_id :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

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.

authorizer_authType :: Lens' Authorizer (Maybe Text) Source #

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #

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.

authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

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.

DeleteUsagePlan

deleteUsagePlan_usagePlanId :: Lens' DeleteUsagePlan Text Source #

Required
The Id of the to-be-deleted usage plan.

UpdateUsagePlan

updateUsagePlan_patchOperations :: Lens' UpdateUsagePlan (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateUsagePlan_usagePlanId :: Lens' UpdateUsagePlan Text Source #

Required
The Id of the to-be-updated usage plan.

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

The request throttle limits of a usage plan.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The maximum number of permitted requests per a given unit time interval.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetStage

getStage_restApiId :: Lens' GetStage Text Source #

Required
The string identifier of the associated RestApi.

getStage_stageName :: Lens' GetStage Text Source #

Required
The name of the Stage resource to get information about.

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the stage points to.

stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_documentationVersion :: Lens' Stage (Maybe Text) Source #

The version of the associated API documentation.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for an API stage.

stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #

The status of the cache cluster for the stage, if enabled.

stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage last updated.

stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #

The size of the cache cluster for the stage, if enabled.

stage_webAclArn :: Lens' Stage (Maybe Text) Source #

The ARN of the WebAcl associated with the Stage.

stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #

Settings for the canary deployment in this stage.

stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether a cache cluster is enabled for the stage.

stage_stageName :: Lens' Stage (Maybe Text) Source #

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

stage_description :: Lens' Stage (Maybe Text) Source #

The stage's description.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetExport

getExport_parameters :: Lens' GetExport (Maybe (HashMap Text Text)) Source #

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

getExport_accepts :: Lens' GetExport (Maybe Text) Source #

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

getExport_restApiId :: Lens' GetExport Text Source #

Required
The string identifier of the associated RestApi.

getExport_stageName :: Lens' GetExport Text Source #

Required
The name of the Stage that will be exported.

getExport_exportType :: Lens' GetExport Text Source #

Required
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

getExportResponse_body :: Lens' GetExportResponse (Maybe ByteString) Source #

The binary blob response to GetExport, which contains the export.

getExportResponse_contentDisposition :: Lens' GetExportResponse (Maybe Text) Source #

The content-disposition header value in the HTTP response.

getExportResponse_contentType :: Lens' GetExportResponse (Maybe Text) Source #

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

getExportResponse_httpStatus :: Lens' GetExportResponse Int Source #

The response's http status code.

GetSdk

getSdk_parameters :: Lens' GetSdk (Maybe (HashMap Text Text)) Source #

A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

getSdk_restApiId :: Lens' GetSdk Text Source #

Required
The string identifier of the associated RestApi.

getSdk_stageName :: Lens' GetSdk Text Source #

Required
The name of the Stage that the SDK will use.

getSdk_sdkType :: Lens' GetSdk Text Source #

Required
The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

getSdkResponse_body :: Lens' GetSdkResponse (Maybe ByteString) Source #

The binary blob response to GetSdk, which contains the generated SDK.

getSdkResponse_contentDisposition :: Lens' GetSdkResponse (Maybe Text) Source #

The content-disposition header value in the HTTP response.

getSdkResponse_contentType :: Lens' GetSdkResponse (Maybe Text) Source #

The content-type header value in the HTTP response.

getSdkResponse_httpStatus :: Lens' GetSdkResponse Int Source #

The response's http status code.

GetApiKeys

getApiKeys_includeValues :: Lens' GetApiKeys (Maybe Bool) Source #

A boolean flag to specify whether (true) or not (false) the result contains key values.

getApiKeys_customerId :: Lens' GetApiKeys (Maybe Text) Source #

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

getApiKeys_nameQuery :: Lens' GetApiKeys (Maybe Text) Source #

The name of queried API keys.

getApiKeys_limit :: Lens' GetApiKeys (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getApiKeys_position :: Lens' GetApiKeys (Maybe Text) Source #

The current pagination position in the paged result set.

getApiKeysResponse_items :: Lens' GetApiKeysResponse (Maybe [ApiKey]) Source #

The current page of elements from this collection.

getApiKeysResponse_warnings :: Lens' GetApiKeysResponse (Maybe [Text]) Source #

A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

getApiKeysResponse_position :: Lens' GetApiKeysResponse (Maybe Text) Source #

Undocumented member.

getApiKeysResponse_httpStatus :: Lens' GetApiKeysResponse Int Source #

The response's http status code.

DeleteBasePathMapping

deleteBasePathMapping_domainName :: Lens' DeleteBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to delete.

deleteBasePathMapping_basePath :: Lens' DeleteBasePathMapping Text Source #

Required
The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

UpdateBasePathMapping

updateBasePathMapping_patchOperations :: Lens' UpdateBasePathMapping (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateBasePathMapping_domainName :: Lens' UpdateBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to change.

updateBasePathMapping_basePath :: Lens' UpdateBasePathMapping Text Source #

Required
The base path of the BasePathMapping resource to change.

To specify an empty base path, set this parameter to '(none)'.

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name.

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.

DeleteClientCertificate

deleteClientCertificate_clientCertificateId :: Lens' DeleteClientCertificate Text Source #

Required
The identifier of the ClientCertificate resource to be deleted.

UpdateClientCertificate

updateClientCertificate_patchOperations :: Lens' UpdateClientCertificate (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateClientCertificate_clientCertificateId :: Lens' UpdateClientCertificate Text Source #

Required
The identifier of the ClientCertificate resource to be updated.

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetGatewayResponse

getGatewayResponse_restApiId :: Lens' GetGatewayResponse Text Source #

Required
The string identifier of the associated RestApi.

getGatewayResponse_responseType :: Lens' GetGatewayResponse GatewayResponseType Source #

Required

The response type of the associated GatewayResponse.

gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse.

gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse.

gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

CreateUsagePlanKey

createUsagePlanKey_usagePlanId :: Lens' CreateUsagePlanKey Text Source #

Required
The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

createUsagePlanKey_keyId :: Lens' CreateUsagePlanKey Text Source #

Required
The identifier of a UsagePlanKey resource for a plan customer.

createUsagePlanKey_keyType :: Lens' CreateUsagePlanKey Text Source #

Required
The type of a UsagePlanKey resource for a plan customer.

usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text) Source #

The value of a usage plan key.

usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text) Source #

The name of a usage plan key.

usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text) Source #

The Id of a usage plan key.

usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text) Source #

The type of a usage plan key. Currently, the valid key type is API_KEY.

CreateAuthorizer

createAuthorizer_authorizerUri :: Lens' CreateAuthorizer (Maybe Text) Source #

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.

createAuthorizer_identityValidationExpression :: Lens' CreateAuthorizer (Maybe Text) Source #

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.

createAuthorizer_providerARNs :: Lens' CreateAuthorizer (Maybe [Text]) Source #

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.

createAuthorizer_authorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Int) Source #

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.

createAuthorizer_authType :: Lens' CreateAuthorizer (Maybe Text) Source #

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

createAuthorizer_identitySource :: Lens' CreateAuthorizer (Maybe Text) Source #

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.

createAuthorizer_authorizerCredentials :: Lens' CreateAuthorizer (Maybe Text) Source #

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.

createAuthorizer_restApiId :: Lens' CreateAuthorizer Text Source #

Required
The string identifier of the associated RestApi.

createAuthorizer_name :: Lens' CreateAuthorizer Text Source #

Required
The name of the authorizer.

createAuthorizer_type :: Lens' CreateAuthorizer AuthorizerType Source #

Required
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #

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.

authorizer_name :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

authorizer_id :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

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.

authorizer_authType :: Lens' Authorizer (Maybe Text) Source #

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #

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.

authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

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.

UpdateAuthorizer

updateAuthorizer_patchOperations :: Lens' UpdateAuthorizer (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateAuthorizer_restApiId :: Lens' UpdateAuthorizer Text Source #

Required
The string identifier of the associated RestApi.

updateAuthorizer_authorizerId :: Lens' UpdateAuthorizer Text Source #

Required
The identifier of the Authorizer resource.

authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #

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.

authorizer_name :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

authorizer_id :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

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.

authorizer_authType :: Lens' Authorizer (Maybe Text) Source #

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #

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.

authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

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.

DeleteAuthorizer

deleteAuthorizer_restApiId :: Lens' DeleteAuthorizer Text Source #

Required
The string identifier of the associated RestApi.

deleteAuthorizer_authorizerId :: Lens' DeleteAuthorizer Text Source #

Required
The identifier of the Authorizer resource.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

Required
The ARN of a resource that can be tagged.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Required
The key-value map of strings. The valid character set is
a-zA-Z+-=._:/
. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateStage

createStage_variables :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

createStage_documentationVersion :: Lens' CreateStage (Maybe Text) Source #

The version of the associated API documentation.

createStage_tracingEnabled :: Lens' CreateStage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

createStage_cacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize) Source #

The stage's cache cluster size.

createStage_canarySettings :: Lens' CreateStage (Maybe CanarySettings) Source #

The canary deployment settings of this stage.

createStage_cacheClusterEnabled :: Lens' CreateStage (Maybe Bool) Source #

Whether cache clustering is enabled for the stage.

createStage_description :: Lens' CreateStage (Maybe Text) Source #

The description of the Stage resource.

createStage_tags :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

createStage_restApiId :: Lens' CreateStage Text Source #

Required
The string identifier of the associated RestApi.

createStage_stageName :: Lens' CreateStage Text Source #

Required
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

createStage_deploymentId :: Lens' CreateStage Text Source #

Required
The identifier of the Deployment resource for the Stage resource.

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the stage points to.

stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_documentationVersion :: Lens' Stage (Maybe Text) Source #

The version of the associated API documentation.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for an API stage.

stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #

The status of the cache cluster for the stage, if enabled.

stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage last updated.

stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #

The size of the cache cluster for the stage, if enabled.

stage_webAclArn :: Lens' Stage (Maybe Text) Source #

The ARN of the WebAcl associated with the Stage.

stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #

Settings for the canary deployment in this stage.

stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether a cache cluster is enabled for the stage.

stage_stageName :: Lens' Stage (Maybe Text) Source #

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

stage_description :: Lens' Stage (Maybe Text) Source #

The stage's description.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteUsagePlanKey

deleteUsagePlanKey_usagePlanId :: Lens' DeleteUsagePlanKey Text Source #

Required
The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

deleteUsagePlanKey_keyId :: Lens' DeleteUsagePlanKey Text Source #

Required
The Id of the UsagePlanKey resource to be deleted.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

Required
The ARN of a resource that can be tagged.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Required
The Tag keys to delete.

CreateApiKey

createApiKey_enabled :: Lens' CreateApiKey (Maybe Bool) Source #

Specifies whether the ApiKey can be used by callers.

createApiKey_value :: Lens' CreateApiKey (Maybe Text) Source #

Specifies a value of the API key.

createApiKey_customerId :: Lens' CreateApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

createApiKey_generateDistinctId :: Lens' CreateApiKey (Maybe Bool) Source #

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

createApiKey_name :: Lens' CreateApiKey (Maybe Text) Source #

The name of the ApiKey.

createApiKey_stageKeys :: Lens' CreateApiKey (Maybe [StageKey]) Source #

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

createApiKey_description :: Lens' CreateApiKey (Maybe Text) Source #

The description of the ApiKey.

createApiKey_tags :: Lens' CreateApiKey (Maybe (HashMap Text Text)) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

GetUsagePlans

getUsagePlans_keyId :: Lens' GetUsagePlans (Maybe Text) Source #

The identifier of the API key associated with the usage plans.

getUsagePlans_limit :: Lens' GetUsagePlans (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getUsagePlans_position :: Lens' GetUsagePlans (Maybe Text) Source #

The current pagination position in the paged result set.

getUsagePlansResponse_items :: Lens' GetUsagePlansResponse (Maybe [UsagePlan]) Source #

The current page of elements from this collection.

getUsagePlansResponse_position :: Lens' GetUsagePlansResponse (Maybe Text) Source #

Undocumented member.

getUsagePlansResponse_httpStatus :: Lens' GetUsagePlansResponse Int Source #

The response's http status code.

PutMethod

putMethod_authorizationScopes :: Lens' PutMethod (Maybe [Text]) Source #

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

putMethod_requestValidatorId :: Lens' PutMethod (Maybe Text) Source #

The identifier of a RequestValidator for validating the method request.

putMethod_requestModels :: Lens' PutMethod (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

putMethod_requestParameters :: Lens' PutMethod (Maybe (HashMap Text Bool)) Source #

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

putMethod_authorizerId :: Lens' PutMethod (Maybe Text) Source #

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

putMethod_operationName :: Lens' PutMethod (Maybe Text) Source #

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

putMethod_apiKeyRequired :: Lens' PutMethod (Maybe Bool) Source #

Specifies whether the method required a valid ApiKey.

putMethod_restApiId :: Lens' PutMethod Text Source #

Required
The string identifier of the associated RestApi.

putMethod_resourceId :: Lens' PutMethod Text Source #

Required
The Resource identifier for the new Method resource.

putMethod_httpMethod :: Lens' PutMethod Text Source #

Required
Specifies the method request's HTTP method type.

putMethod_authorizationType :: Lens' PutMethod Text Source #

Required
The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI

method_httpMethod :: Lens' Method (Maybe Text) Source #

The method's HTTP verb.

method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

method_requestValidatorId :: Lens' Method (Maybe Text) Source #

The identifier of a RequestValidator for request validation.

method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

method_authorizerId :: Lens' Method (Maybe Text) Source #

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

method_operationName :: Lens' Method (Maybe Text) Source #

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

method_authorizationType :: Lens' Method (Maybe Text) Source #

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

method_methodIntegration :: Lens' Method (Maybe Integration) Source #

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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 } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI

UpdateDomainName

updateDomainName_patchOperations :: Lens' UpdateDomainName (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDomainName_domainName :: Lens' UpdateDomainName Text Source #

Required
The name of the DomainName resource to be changed.

domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_certificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

domainName_certificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_domainName :: Lens' DomainName (Maybe Text) Source #

The custom domain name as an API host name, for example, my-api.example.com.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used for validating the regional domain name.

domainName_regionalDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainName_distributionDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #

The status of the DomainName migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

DeleteDomainName

deleteDomainName_domainName :: Lens' DeleteDomainName Text Source #

Required
The name of the DomainName resource to be deleted.

CreateResource

createResource_restApiId :: Lens' CreateResource Text Source #

Required
The string identifier of the associated RestApi.

createResource_parentId :: Lens' CreateResource Text Source #

Required
The parent resource's identifier.

createResource_pathPart :: Lens' CreateResource Text Source #

The last path segment for this resource.

resource_pathPart :: Lens' Resource (Maybe Text) Source #

The last path segment for this resource.

resource_path :: Lens' Resource (Maybe Text) Source #

The full path for this resource.

resource_id :: Lens' Resource (Maybe Text) Source #

The resource's identifier.

resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method)) Source #

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "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" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

resource_parentId :: Lens' Resource (Maybe Text) Source #

The parent resource's identifier.

DeleteMethod

deleteMethod_restApiId :: Lens' DeleteMethod Text Source #

Required
The string identifier of the associated RestApi.

deleteMethod_resourceId :: Lens' DeleteMethod Text Source #

Required
The Resource identifier for the Method resource.

deleteMethod_httpMethod :: Lens' DeleteMethod Text Source #

Required
The HTTP verb of the Method resource.

UpdateMethod

updateMethod_patchOperations :: Lens' UpdateMethod (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateMethod_restApiId :: Lens' UpdateMethod Text Source #

Required
The string identifier of the associated RestApi.

updateMethod_resourceId :: Lens' UpdateMethod Text Source #

Required
The Resource identifier for the Method resource.

updateMethod_httpMethod :: Lens' UpdateMethod Text Source #

Required
The HTTP verb of the Method resource.

method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI

method_httpMethod :: Lens' Method (Maybe Text) Source #

The method's HTTP verb.

method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

method_requestValidatorId :: Lens' Method (Maybe Text) Source #

The identifier of a RequestValidator for request validation.

method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

method_authorizerId :: Lens' Method (Maybe Text) Source #

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

method_operationName :: Lens' Method (Maybe Text) Source #

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

method_authorizationType :: Lens' Method (Maybe Text) Source #

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

method_methodIntegration :: Lens' Method (Maybe Integration) Source #

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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 } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI

UpdateRequestValidator

updateRequestValidator_patchOperations :: Lens' UpdateRequestValidator (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateRequestValidator_restApiId :: Lens' UpdateRequestValidator Text Source #

Required
The string identifier of the associated RestApi.

updateRequestValidator_requestValidatorId :: Lens' UpdateRequestValidator Text Source #

Required
The identifier of RequestValidator to be updated.

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #

The identifier of this RequestValidator.

DeleteRequestValidator

deleteRequestValidator_restApiId :: Lens' DeleteRequestValidator Text Source #

Required
The string identifier of the associated RestApi.

deleteRequestValidator_requestValidatorId :: Lens' DeleteRequestValidator Text Source #

Required
The identifier of the RequestValidator to be deleted.

GetSdkTypes

getSdkTypes_limit :: Lens' GetSdkTypes (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getSdkTypes_position :: Lens' GetSdkTypes (Maybe Text) Source #

The current pagination position in the paged result set.

getSdkTypesResponse_items :: Lens' GetSdkTypesResponse (Maybe [SdkType]) Source #

The current page of elements from this collection.

getSdkTypesResponse_position :: Lens' GetSdkTypesResponse (Maybe Text) Source #

Undocumented member.

getSdkTypesResponse_httpStatus :: Lens' GetSdkTypesResponse Int Source #

The response's http status code.

GetClientCertificates

getClientCertificates_limit :: Lens' GetClientCertificates (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getClientCertificates_position :: Lens' GetClientCertificates (Maybe Text) Source #

The current pagination position in the paged result set.

getClientCertificatesResponse_items :: Lens' GetClientCertificatesResponse (Maybe [ClientCertificate]) Source #

The current page of elements from this collection.

getClientCertificatesResponse_position :: Lens' GetClientCertificatesResponse (Maybe Text) Source #

Undocumented member.

getClientCertificatesResponse_httpStatus :: Lens' GetClientCertificatesResponse Int Source #

The response's http status code.

GetModelTemplate

getModelTemplate_restApiId :: Lens' GetModelTemplate Text Source #

Required
The string identifier of the associated RestApi.

getModelTemplate_modelName :: Lens' GetModelTemplate Text Source #

Required
The name of the model for which to generate a template.

getModelTemplateResponse_value :: Lens' GetModelTemplateResponse (Maybe Text) Source #

The Apache Velocity Template Language (VTL) template content used for the template resource.

getModelTemplateResponse_httpStatus :: Lens' GetModelTemplateResponse Int Source #

The response's http status code.

UpdateDocumentationVersion

updateDocumentationVersion_patchOperations :: Lens' UpdateDocumentationVersion (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDocumentationVersion_restApiId :: Lens' UpdateDocumentationVersion Text Source #

Required
The string identifier of the associated RestApi..

updateDocumentationVersion_documentationVersion :: Lens' UpdateDocumentationVersion Text Source #

Required
The version identifier of the to-be-updated documentation version.

documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.

DeleteDocumentationVersion

deleteDocumentationVersion_restApiId :: Lens' DeleteDocumentationVersion Text Source #

Required
The string identifier of the associated RestApi.

deleteDocumentationVersion_documentationVersion :: Lens' DeleteDocumentationVersion Text Source #

Required
The version identifier of a to-be-deleted documentation snapshot.

GetBasePathMappings

getBasePathMappings_limit :: Lens' GetBasePathMappings (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getBasePathMappings_position :: Lens' GetBasePathMappings (Maybe Text) Source #

The current pagination position in the paged result set.

getBasePathMappings_domainName :: Lens' GetBasePathMappings Text Source #

Required
The domain name of a BasePathMapping resource.

getBasePathMappingsResponse_items :: Lens' GetBasePathMappingsResponse (Maybe [BasePathMapping]) Source #

The current page of elements from this collection.

getBasePathMappingsResponse_position :: Lens' GetBasePathMappingsResponse (Maybe Text) Source #

Undocumented member.

getBasePathMappingsResponse_httpStatus :: Lens' GetBasePathMappingsResponse Int Source #

The response's http status code.

GetApiKey

getApiKey_includeValue :: Lens' GetApiKey (Maybe Bool) Source #

A boolean flag to specify whether (true) or not (false) the result contains the key value.

getApiKey_apiKey :: Lens' GetApiKey Text Source #

Required
The identifier of the ApiKey resource.

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

Types

AccessLogSettings

accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text) Source #

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

Account

account_apiKeyVersion :: Lens' Account (Maybe Text) Source #

The version of the API keys used for the account.

account_cloudwatchRoleArn :: Lens' Account (Maybe Text) Source #

The ARN of an Amazon CloudWatch role for the current Account.

account_features :: Lens' Account (Maybe [Text]) Source #

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

account_throttleSettings :: Lens' Account (Maybe ThrottleSettings) Source #

Specifies the API request limits configured for the current Account.

ApiKey

apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

apiKey_value :: Lens' ApiKey (Maybe Text) Source #

The value of the API Key.

apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

apiKey_name :: Lens' ApiKey (Maybe Text) Source #

The name of the API Key.

apiKey_id :: Lens' ApiKey (Maybe Text) Source #

The identifier of the API Key.

apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #

A list of Stage resources that are associated with the ApiKey resource.

apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

apiKey_description :: Lens' ApiKey (Maybe Text) Source #

The description of the API Key.

apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

ApiStage

apiStage_stage :: Lens' ApiStage (Maybe Text) Source #

API stage name of the associated API stage in a usage plan.

apiStage_apiId :: Lens' ApiStage (Maybe Text) Source #

API Id of the associated API stage in a usage plan.

apiStage_throttle :: Lens' ApiStage (Maybe (HashMap Text ThrottleSettings)) Source #

Map containing method level throttling information for API stage in a usage plan.

Authorizer

authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #

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.

authorizer_name :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

authorizer_id :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

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.

authorizer_authType :: Lens' Authorizer (Maybe Text) Source #

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #

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.

authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #

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.

authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

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.

BasePathMapping

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name.

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.

CanarySettings

canarySettings_deploymentId :: Lens' CanarySettings (Maybe Text) Source #

The ID of the canary deployment.

canarySettings_stageVariableOverrides :: Lens' CanarySettings (Maybe (HashMap Text Text)) Source #

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.

canarySettings_useStageCache :: Lens' CanarySettings (Maybe Bool) Source #

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

canarySettings_percentTraffic :: Lens' CanarySettings (Maybe Double) Source #

The percent (0-100) of traffic diverted to a canary deployment.

ClientCertificate

clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

Deployment

deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

deployment_id :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

DeploymentCanarySettings

deploymentCanarySettings_stageVariableOverrides :: Lens' DeploymentCanarySettings (Maybe (HashMap Text Text)) Source #

A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

deploymentCanarySettings_useStageCache :: Lens' DeploymentCanarySettings (Maybe Bool) Source #

A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

deploymentCanarySettings_percentTraffic :: Lens' DeploymentCanarySettings (Maybe Double) Source #

The percentage (0.0-100.0) of traffic routed to the canary deployment.

DocumentationPart

documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #

The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

DocumentationPartLocation

documentationPartLocation_path :: Lens' DocumentationPartLocation (Maybe Text) Source #

The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

documentationPartLocation_name :: Lens' DocumentationPartLocation (Maybe Text) Source #

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

documentationPartLocation_method :: Lens' DocumentationPartLocation (Maybe Text) Source #

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

documentationPartLocation_statusCode :: Lens' DocumentationPartLocation (Maybe Text) Source #

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

documentationPartLocation_type :: Lens' DocumentationPartLocation DocumentationPartType Source #

Required
The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.

DocumentationVersion

documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.

DomainName

domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_certificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #

The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

domainName_certificateArn :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_domainName :: Lens' DomainName (Maybe Text) Source #

The custom domain name as an API host name, for example, my-api.example.com.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used for validating the regional domain name.

domainName_regionalDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

domainName_distributionDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #

The status of the DomainName migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

EndpointConfiguration

endpointConfiguration_types :: Lens' EndpointConfiguration (Maybe [EndpointType]) Source #

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

endpointConfiguration_vpcEndpointIds :: Lens' EndpointConfiguration (Maybe [Text]) Source #

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

GatewayResponse

gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse.

gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse.

gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Integration

integration_httpMethod :: Lens' Integration (Maybe Text) Source #

Specifies the integration's HTTP method type.

integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

integration_credentials :: Lens' Integration (Maybe Text) Source #

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

integration_connectionId :: Lens' Integration (Maybe Text) Source #

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

integration_passthroughBehavior :: Lens' Integration (Maybe Text) Source #

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

integration_uri :: Lens' Integration (Maybe Text) Source #

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #

Specifies the integration's responses.

Example: Get integration responses of a method

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/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-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #

Specifies the TLS configuration for an integration.

integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

integration_type :: Lens' Integration (Maybe IntegrationType) Source #

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

IntegrationResponse

integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse.

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

Method

method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI

method_httpMethod :: Lens' Method (Maybe Text) Source #

The method's HTTP verb.

method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

method_requestValidatorId :: Lens' Method (Maybe Text) Source #

The identifier of a RequestValidator for request validation.

method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

method_authorizerId :: Lens' Method (Maybe Text) Source #

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

method_operationName :: Lens' Method (Maybe Text) Source #

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

method_authorizationType :: Lens' Method (Maybe Text) Source #

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

method_methodIntegration :: Lens' Method (Maybe Integration) Source #

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request
GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/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 } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI

MethodResponse

methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #

The method response's status code.

methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

MethodSetting

methodSetting_cacheTtlInSeconds :: Lens' MethodSetting (Maybe Int) Source #

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

methodSetting_dataTraceEnabled :: Lens' MethodSetting (Maybe Bool) Source #

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

methodSetting_throttlingBurstLimit :: Lens' MethodSetting (Maybe Int) Source #

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

methodSetting_cacheDataEncrypted :: Lens' MethodSetting (Maybe Bool) Source #

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

methodSetting_loggingLevel :: Lens' MethodSetting (Maybe Text) Source #

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

methodSetting_requireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool) Source #

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

methodSetting_cachingEnabled :: Lens' MethodSetting (Maybe Bool) Source #

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

methodSetting_metricsEnabled :: Lens' MethodSetting (Maybe Bool) Source #

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

methodSetting_throttlingRateLimit :: Lens' MethodSetting (Maybe Double) Source #

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

methodSetting_unauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy) Source #

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

MethodSnapshot

methodSnapshot_authorizationType :: Lens' MethodSnapshot (Maybe Text) Source #

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

methodSnapshot_apiKeyRequired :: Lens' MethodSnapshot (Maybe Bool) Source #

Specifies whether the method requires a valid ApiKey.

Model

model_schema :: Lens' Model (Maybe Text) Source #

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

model_name :: Lens' Model (Maybe Text) Source #

The name of the model. Must be an alphanumeric string.

model_id :: Lens' Model (Maybe Text) Source #

The identifier for the model resource.

model_description :: Lens' Model (Maybe Text) Source #

The description of the model.

model_contentType :: Lens' Model (Maybe Text) Source #

The content-type for the model.

MutualTlsAuthentication

mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text]) Source #

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text) Source #

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text) Source #

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

MutualTlsAuthenticationInput

mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #

An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

PatchOperation

patchOperation_op :: Lens' PatchOperation (Maybe Op) Source #

An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

patchOperation_path :: Lens' PatchOperation (Maybe Text) Source #

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

patchOperation_value :: Lens' PatchOperation (Maybe Text) Source #

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.

patchOperation_from :: Lens' PatchOperation (Maybe Text) Source #

The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".

QuotaSettings

quotaSettings_offset :: Lens' QuotaSettings (Maybe Int) Source #

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType) Source #

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

quotaSettings_limit :: Lens' QuotaSettings (Maybe Int) Source #

The maximum number of requests that can be made in a given time period.

RequestValidator

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #

The identifier of this RequestValidator.

Resource

resource_pathPart :: Lens' Resource (Maybe Text) Source #

The last path segment for this resource.

resource_path :: Lens' Resource (Maybe Text) Source #

The full path for this resource.

resource_id :: Lens' Resource (Maybe Text) Source #

The resource's identifier.

resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method)) Source #

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ "_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": false, "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#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "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" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

resource_parentId :: Lens' Resource (Maybe Text) Source #

The parent resource's identifier.

RestApi

restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #

The warning messages reported when failonwarnings is turned on during API import.

restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #

The timestamp when the API was created.

restApi_name :: Lens' RestApi (Maybe Text) Source #

The API's name.

restApi_version :: Lens' RestApi (Maybe Text) Source #

A version identifier for the API.

restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

restApi_id :: Lens' RestApi (Maybe Text) Source #

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

restApi_policy :: Lens' RestApi (Maybe Text) Source #

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #

The endpoint configuration of this RestApi showing the endpoint types of the API.

restApi_description :: Lens' RestApi (Maybe Text) Source #

The API's description.

restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

SdkConfigurationProperty

sdkConfigurationProperty_friendlyName :: Lens' SdkConfigurationProperty (Maybe Text) Source #

The user-friendly name of an SdkType configuration property.

sdkConfigurationProperty_required :: Lens' SdkConfigurationProperty (Maybe Bool) Source #

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

sdkConfigurationProperty_name :: Lens' SdkConfigurationProperty (Maybe Text) Source #

The name of a an SdkType configuration property.

sdkConfigurationProperty_defaultValue :: Lens' SdkConfigurationProperty (Maybe Text) Source #

The default value of an SdkType configuration property.

sdkConfigurationProperty_description :: Lens' SdkConfigurationProperty (Maybe Text) Source #

The description of an SdkType configuration property.

SdkType

sdkType_friendlyName :: Lens' SdkType (Maybe Text) Source #

The user-friendly name of an SdkType instance.

sdkType_configurationProperties :: Lens' SdkType (Maybe [SdkConfigurationProperty]) Source #

A list of configuration properties of an SdkType.

sdkType_id :: Lens' SdkType (Maybe Text) Source #

The identifier of an SdkType instance.

sdkType_description :: Lens' SdkType (Maybe Text) Source #

The description of an SdkType.

Stage

stage_deploymentId :: Lens' Stage (Maybe Text) Source #

The identifier of the Deployment that the stage points to.

stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #

Settings for logging access in this stage.

stage_documentationVersion :: Lens' Stage (Maybe Text) Source #

The version of the associated API documentation.

stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #

The identifier of a client certificate for an API stage.

stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether active tracing with X-ray is enabled for the Stage.

stage_createdDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage was created.

stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #

The status of the cache cluster for the stage, if enabled.

stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #

The timestamp when the stage last updated.

stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #

The size of the cache cluster for the stage, if enabled.

stage_webAclArn :: Lens' Stage (Maybe Text) Source #

The ARN of the WebAcl associated with the Stage.

stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #

Settings for the canary deployment in this stage.

stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #

Specifies whether a cache cluster is enabled for the stage.

stage_stageName :: Lens' Stage (Maybe Text) Source #

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

stage_description :: Lens' Stage (Maybe Text) Source #

The stage's description.

stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

StageKey

stageKey_restApiId :: Lens' StageKey (Maybe Text) Source #

The string identifier of the associated RestApi.

stageKey_stageName :: Lens' StageKey (Maybe Text) Source #

The stage name associated with the stage key.

ThrottleSettings

throttleSettings_burstLimit :: Lens' ThrottleSettings (Maybe Int) Source #

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

throttleSettings_rateLimit :: Lens' ThrottleSettings (Maybe Double) Source #

The API request steady-state rate limit.

TlsConfig

tlsConfig_insecureSkipVerification :: Lens' TlsConfig (Maybe Bool) Source #

Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.

Usage

usage_usagePlanId :: Lens' Usage (Maybe Text) Source #

The plan Id associated with this usage data.

usage_endDate :: Lens' Usage (Maybe Text) Source #

The ending date of the usage data.

usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]])) Source #

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

usage_startDate :: Lens' Usage (Maybe Text) Source #

The starting date of the usage data.

usage_position :: Lens' Usage (Maybe Text) Source #

Undocumented member.

UsagePlan

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

The request throttle limits of a usage plan.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The maximum number of permitted requests per a given unit time interval.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

UsagePlanKey

usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text) Source #

The value of a usage plan key.

usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text) Source #

The name of a usage plan key.

usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text) Source #

The Id of a usage plan key.

usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text) Source #

The type of a usage plan key. Currently, the valid key type is API_KEY.

VpcLink

vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

vpcLink_targetArns :: Lens' VpcLink (Maybe [Text]) Source #

The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

vpcLink_name :: Lens' VpcLink (Maybe Text) Source #

The name used to label and identify the VPC link.

vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #

A description about the VPC link status.

vpcLink_id :: Lens' VpcLink (Maybe Text) Source #

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

vpcLink_description :: Lens' VpcLink (Maybe Text) Source #

The description of the VPC link.

vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.