Api Gateway

create_api_key()
create_api_key(params::Dict{String,<:Any})

Create an ApiKey resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "customerId": An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
• "description": The description of the ApiKey.
• "enabled": Specifies whether the ApiKey can be used by callers.
• "generateDistinctId": 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.
• "name": The name of the ApiKey.
• "stageKeys": DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
• "tags": 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.
• "value": Specifies a value of the API key.

create_authorizer(name, restapi_id, type)
create_authorizer(name, restapi_id, type, params::Dict{String,<:Any})

Adds a new Authorizer resource to an existing RestApi resource.

Arguments

• name: The name of the authorizer.
• restapi_id: The string identifier of the associated RestApi.
• type: The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITOUSERPOOLS for using an Amazon Cognito user pool.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "authType": Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
• "authorizerCredentials": Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
• "authorizerResultTtlInSeconds": The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
• "authorizerUri": Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{acco untid}:function:{lambdafunctionname}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{serviceapi}, 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.
• "identitySource": The identity source for which authorization is requested. For a TOKEN or COGNITOUSERPOOLS 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.
• "identityValidationExpression": A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITOUSERPOOLS 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.
• "providerARNs": A list of the Amazon Cognito user pool ARNs for the COGNITOUSERPOOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{accountid}:userpool/{userpool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

create_base_path_mapping(domain_name, rest_api_id)
create_base_path_mapping(domain_name, rest_api_id, params::Dict{String,<:Any})

Creates a new BasePathMapping resource.

Arguments

• domain_name: The domain name of the BasePathMapping resource to create.
• rest_api_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "basePath": 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.
• "stage": 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.

create_deployment(restapi_id)
create_deployment(restapi_id, params::Dict{String,<:Any})

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cacheClusterEnabled": Enables a cache cluster for the Stage resource specified in the input.
• "cacheClusterSize": The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
• "canarySettings": The input configuration for the canary deployment when the deployment is a canary release deployment.
• "description": The description for the Deployment resource to create.
• "stageDescription": The description of the Stage resource for the Deployment resource to create.
• "stageName": The name of the Stage resource for the Deployment resource to create.
• "tracingEnabled": Specifies whether active tracing with X-ray is enabled for the Stage.
• "variables": 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-._~:/?#&=,]+.

create_documentation_part(location, properties, restapi_id)
create_documentation_part(location, properties, restapi_id, params::Dict{String,<:Any})

Creates a documentation part.

Arguments

• location: The location of the targeted API entity of the to-be-created documentation part.
• properties: 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.
• restapi_id: The string identifier of the associated RestApi.

create_documentation_version(documentation_version, restapi_id)
create_documentation_version(documentation_version, restapi_id, params::Dict{String,<:Any})

Creates a documentation version

Arguments

• documentation_version: The version identifier of the new snapshot.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": A description about the new documentation snapshot.
• "stageName": The stage name to be associated with the new documentation snapshot.

create_domain_name(domain_name)
create_domain_name(domain_name, params::Dict{String,<:Any})

Creates a new domain name.

Arguments

• domain_name: The name of the DomainName resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "certificateArn": The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
• "certificateBody": [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
• "certificateChain": [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.
• "certificateName": The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
• "certificatePrivateKey": [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
• "endpointConfiguration": The endpoint configuration of this DomainName showing the endpoint types of the domain name.
• "mutualTlsAuthentication":
• "ownershipVerificationCertificateArn": 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.
• "regionalCertificateArn": The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
• "regionalCertificateName": The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
• "securityPolicy": The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS10 and TLS12.
• "tags": 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.

create_model(content_type, name, restapi_id)
create_model(content_type, name, restapi_id, params::Dict{String,<:Any})

Adds a new Model resource to an existing RestApi resource.

Arguments

• content_type: The content-type for the model.
• name: The name of the model. Must be alphanumeric.
• restapi_id: The RestApi identifier under which the Model will be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the model.
• "schema": The schema for the model. For application/json models, this should be JSON schema draft 4 model. The maximum size of the model is 400 KB.

create_request_validator(restapi_id)
create_request_validator(restapi_id, params::Dict{String,<:Any})

Creates a RequestValidator of a given RestApi.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "name": The name of the to-be-created RequestValidator.
• "validateRequestBody": A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
• "validateRequestParameters": A Boolean flag to indicate whether to validate request parameters, true, or not false.

create_resource(parent_id, path_part, restapi_id)
create_resource(parent_id, path_part, restapi_id, params::Dict{String,<:Any})

Creates a Resource resource.

Arguments

• parent_id: The parent resource's identifier.
• path_part: The last path segment for this resource.
• restapi_id: The string identifier of the associated RestApi.

create_rest_api(name)
create_rest_api(name, params::Dict{String,<:Any})

Creates a new RestApi resource.

Arguments

• name: The name of the RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "apiKeySource": 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.
• "binaryMediaTypes": The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
• "cloneFrom": The ID of the RestApi that you want to clone from.
• "description": The description of the RestApi.
• "disableExecuteApiEndpoint": 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
• "endpointConfiguration": The endpoint configuration of this RestApi showing the endpoint types of the API.
• "minimumCompressionSize": 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.
• "policy": A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
• "tags": 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.
• "version": A version identifier for the API.

create_stage(deployment_id, restapi_id, stage_name)
create_stage(deployment_id, restapi_id, stage_name, params::Dict{String,<:Any})

Creates a new Stage resource that references a pre-existing Deployment for the API.

Arguments

• deployment_id: The identifier of the Deployment resource for the Stage resource.
• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cacheClusterEnabled": Whether cache clustering is enabled for the stage.
• "cacheClusterSize": The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
• "canarySettings": The canary deployment settings of this stage.
• "description": The description of the Stage resource.
• "documentationVersion": The version of the associated API documentation.
• "tags": 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.
• "tracingEnabled": Specifies whether active tracing with X-ray is enabled for the Stage.
• "variables": 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-._~:/?#&=,]+.

create_usage_plan(name)
create_usage_plan(name, params::Dict{String,<:Any})

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Arguments

• name: The name of the usage plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "apiStages": The associated API stages of the usage plan.
• "description": The description of the usage plan.
• "quota": The quota of the usage plan.
• "tags": 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.
• "throttle": The throttling limits of the usage plan.

create_usage_plan_key(key_id, key_type, usageplan_id)
create_usage_plan_key(key_id, key_type, usageplan_id, params::Dict{String,<:Any})

Creates a usage plan key for adding an existing API key to a usage plan.

Arguments

• key_id: The identifier of a UsagePlanKey resource for a plan customer.
• key_type: The type of a UsagePlanKey resource for a plan customer.
• usageplan_id: The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

create_vpc_link(name, target_arns)
create_vpc_link(name, target_arns, params::Dict{String,<:Any})

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

Arguments

• name: The name used to label and identify the VPC link.
• target_arns: 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 Amazon Web Services account of the API owner.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the VPC link.
• "tags": 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.

delete_api_key(api__key)
delete_api_key(api__key, params::Dict{String,<:Any})

Deletes the ApiKey resource.

Arguments

• api__key: The identifier of the ApiKey resource to be deleted.

delete_authorizer(authorizer_id, restapi_id)
delete_authorizer(authorizer_id, restapi_id, params::Dict{String,<:Any})

Deletes an existing Authorizer resource.

Arguments

• authorizer_id: The identifier of the Authorizer resource.
• restapi_id: The string identifier of the associated RestApi.

delete_base_path_mapping(base_path, domain_name)
delete_base_path_mapping(base_path, domain_name, params::Dict{String,<:Any})

Deletes the BasePathMapping resource.

Arguments

• base_path: The base path name of the BasePathMapping resource to delete. To specify an empty base path, set this parameter to '(none)'.
• domain_name: The domain name of the BasePathMapping resource to delete.

delete_client_certificate(clientcertificate_id)
delete_client_certificate(clientcertificate_id, params::Dict{String,<:Any})

Deletes the ClientCertificate resource.

Arguments

• clientcertificate_id: The identifier of the ClientCertificate resource to be deleted.

delete_deployment(deployment_id, restapi_id)
delete_deployment(deployment_id, restapi_id, params::Dict{String,<:Any})

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Arguments

• deployment_id: The identifier of the Deployment resource to delete.
• restapi_id: The string identifier of the associated RestApi.

delete_documentation_part(part_id, restapi_id)
delete_documentation_part(part_id, restapi_id, params::Dict{String,<:Any})

Deletes a documentation part

Arguments

• part_id: The identifier of the to-be-deleted documentation part.
• restapi_id: The string identifier of the associated RestApi.

delete_documentation_version(doc_version, restapi_id)
delete_documentation_version(doc_version, restapi_id, params::Dict{String,<:Any})

Deletes a documentation version.

Arguments

• doc_version: The version identifier of a to-be-deleted documentation snapshot.
• restapi_id: The string identifier of the associated RestApi.

delete_domain_name(domain_name)
delete_domain_name(domain_name, params::Dict{String,<:Any})

Deletes the DomainName resource.

Arguments

• domain_name: The name of the DomainName resource to be deleted.

delete_gateway_response(response_type, restapi_id)
delete_gateway_response(response_type, restapi_id, params::Dict{String,<:Any})

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

Arguments

• response_type: The response type of the associated GatewayResponse.
• restapi_id: The string identifier of the associated RestApi.

delete_integration(http_method, resource_id, restapi_id)
delete_integration(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Represents a delete integration.

Arguments

• http_method: Specifies a delete integration request's HTTP method.
• resource_id: Specifies a delete integration request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.

delete_integration_response(http_method, resource_id, restapi_id, status_code)
delete_integration_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Represents a delete integration response.

Arguments

• http_method: Specifies a delete integration response request's HTTP method.
• resource_id: Specifies a delete integration response request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.
• status_code: Specifies a delete integration response request's status code.

delete_method(http_method, resource_id, restapi_id)
delete_method(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Deletes an existing Method resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the Method resource.
• restapi_id: The string identifier of the associated RestApi.

delete_method_response(http_method, resource_id, restapi_id, status_code)
delete_method_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Deletes an existing MethodResponse resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the MethodResponse resource.
• restapi_id: The string identifier of the associated RestApi.
• status_code: The status code identifier for the MethodResponse resource.

delete_model(model_name, restapi_id)
delete_model(model_name, restapi_id, params::Dict{String,<:Any})

Deletes a model.

Arguments

• model_name: The name of the model to delete.
• restapi_id: The string identifier of the associated RestApi.

delete_request_validator(requestvalidator_id, restapi_id)
delete_request_validator(requestvalidator_id, restapi_id, params::Dict{String,<:Any})

Deletes a RequestValidator of a given RestApi.

Arguments

• requestvalidator_id: The identifier of the RequestValidator to be deleted.
• restapi_id: The string identifier of the associated RestApi.

delete_resource(resource_id, restapi_id)
delete_resource(resource_id, restapi_id, params::Dict{String,<:Any})

Deletes a Resource resource.

Arguments

• resource_id: The identifier of the Resource resource.
• restapi_id: The string identifier of the associated RestApi.

delete_rest_api(restapi_id)
delete_rest_api(restapi_id, params::Dict{String,<:Any})

Deletes the specified API.

Arguments

• restapi_id: The string identifier of the associated RestApi.

delete_stage(restapi_id, stage_name)
delete_stage(restapi_id, stage_name, params::Dict{String,<:Any})

Deletes a Stage resource.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the Stage resource to delete.

delete_usage_plan(usageplan_id)
delete_usage_plan(usageplan_id, params::Dict{String,<:Any})

Deletes a usage plan of a given plan Id.

Arguments

• usageplan_id: The Id of the to-be-deleted usage plan.

delete_usage_plan_key(key_id, usageplan_id)
delete_usage_plan_key(key_id, usageplan_id, params::Dict{String,<:Any})

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Arguments

• key_id: The Id of the UsagePlanKey resource to be deleted.
• usageplan_id: The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

delete_vpc_link(vpclink_id)
delete_vpc_link(vpclink_id, params::Dict{String,<:Any})

Deletes an existing VpcLink of a specified identifier.

Arguments

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

flush_stage_authorizers_cache(restapi_id, stage_name)
flush_stage_authorizers_cache(restapi_id, stage_name, params::Dict{String,<:Any})

Flushes all authorizer cache entries on a stage.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the stage to flush.

flush_stage_cache(restapi_id, stage_name)
flush_stage_cache(restapi_id, stage_name, params::Dict{String,<:Any})

Flushes a stage's cache.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the stage to flush its cache.

generate_client_certificate()
generate_client_certificate(params::Dict{String,<:Any})

Generates a ClientCertificate resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "description": The description of the ClientCertificate.
• "tags": 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.

get_account()
get_account(params::Dict{String,<:Any})

Gets information about the current Account resource.

get_api_key(api__key)
get_api_key(api__key, params::Dict{String,<:Any})

Gets information about the current ApiKey resource.

Arguments

• api__key: The identifier of the ApiKey resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "includeValue": A boolean flag to specify whether (true) or not (false) the result contains the key value.

get_api_keys()
get_api_keys(params::Dict{String,<:Any})

Gets information about the current ApiKeys resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "customerId": The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
• "includeValues": A boolean flag to specify whether (true) or not (false) the result contains key values.
• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "name": The name of queried API keys.
• "position": The current pagination position in the paged result set.

get_authorizer(authorizer_id, restapi_id)
get_authorizer(authorizer_id, restapi_id, params::Dict{String,<:Any})

Describe an existing Authorizer resource.

Arguments

• authorizer_id: The identifier of the Authorizer resource.
• restapi_id: The string identifier of the associated RestApi.

get_authorizers(restapi_id)
get_authorizers(restapi_id, params::Dict{String,<:Any})

Describe an existing Authorizers resource.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_base_path_mapping(base_path, domain_name)
get_base_path_mapping(base_path, domain_name, params::Dict{String,<:Any})

Describe a BasePathMapping resource.

Arguments

• base_path: 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.
• domain_name: The domain name of the BasePathMapping resource to be described.

get_base_path_mappings(domain_name)
get_base_path_mappings(domain_name, params::Dict{String,<:Any})

Represents a collection of BasePathMapping resources.

Arguments

• domain_name: The domain name of a BasePathMapping resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_client_certificate(clientcertificate_id)
get_client_certificate(clientcertificate_id, params::Dict{String,<:Any})

Gets information about the current ClientCertificate resource.

Arguments

• clientcertificate_id: The identifier of the ClientCertificate resource to be described.

get_client_certificates()
get_client_certificates(params::Dict{String,<:Any})

Gets a collection of ClientCertificate resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_deployment(deployment_id, restapi_id)
get_deployment(deployment_id, restapi_id, params::Dict{String,<:Any})

Gets information about a Deployment resource.

Arguments

• deployment_id: The identifier of the Deployment resource to get information about.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "embed": 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/{restapiid}/deployments/{deploymentid}?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/{restapiid}/deployments/{deploymentid}?embed=apisummary.

get_deployments(restapi_id)
get_deployments(restapi_id, params::Dict{String,<:Any})

Gets information about a Deployments collection.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_documentation_part(part_id, restapi_id)
get_documentation_part(part_id, restapi_id, params::Dict{String,<:Any})

Gets a documentation part.

Arguments

• part_id: The string identifier of the associated RestApi.
• restapi_id: The string identifier of the associated RestApi.

get_documentation_parts(restapi_id)
get_documentation_parts(restapi_id, params::Dict{String,<:Any})

Gets documentation parts.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "locationStatus": 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.
• "name": The name of API entities of the to-be-retrieved documentation parts.
• "path": The path of API entities of the to-be-retrieved documentation parts.
• "position": The current pagination position in the paged result set.
• "type": The type of API entities of the to-be-retrieved documentation parts.

get_documentation_version(doc_version, restapi_id)
get_documentation_version(doc_version, restapi_id, params::Dict{String,<:Any})

Gets a documentation version.

Arguments

• doc_version: The version identifier of the to-be-retrieved documentation snapshot.
• restapi_id: The string identifier of the associated RestApi.

get_documentation_versions(restapi_id)
get_documentation_versions(restapi_id, params::Dict{String,<:Any})

Gets documentation versions.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_domain_name(domain_name)
get_domain_name(domain_name, params::Dict{String,<:Any})

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Arguments

• domain_name: The name of the DomainName resource.

get_domain_names()
get_domain_names(params::Dict{String,<:Any})

Represents a collection of DomainName resources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_export(export_type, restapi_id, stage_name)
get_export(export_type, restapi_id, stage_name, params::Dict{String,<:Any})

Exports a deployed version of a RestApi in a specified format.

Arguments

• export_type: The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the Stage that will be exported.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "Accept": 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.
• "parameters": 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

get_gateway_response(response_type, restapi_id)
get_gateway_response(response_type, restapi_id, params::Dict{String,<:Any})

Gets a GatewayResponse of a specified response type on the given RestApi.

Arguments

• response_type: The response type of the associated GatewayResponse.
• restapi_id: The string identifier of the associated RestApi.

get_gateway_responses(restapi_id)
get_gateway_responses(restapi_id, params::Dict{String,<:Any})

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": 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.
• "position": The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

get_integration(http_method, resource_id, restapi_id)
get_integration(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Get the integration settings.

Arguments

• http_method: Specifies a get integration request's HTTP method.
• resource_id: Specifies a get integration request's resource identifier
• restapi_id: The string identifier of the associated RestApi.

get_integration_response(http_method, resource_id, restapi_id, status_code)
get_integration_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Represents a get integration response.

Arguments

• http_method: Specifies a get integration response request's HTTP method.
• resource_id: Specifies a get integration response request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.
• status_code: Specifies a get integration response request's status code.

get_method(http_method, resource_id, restapi_id)
get_method(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Describe an existing Method resource.

Arguments

• http_method: Specifies the method request's HTTP method type.
• resource_id: The Resource identifier for the Method resource.
• restapi_id: The string identifier of the associated RestApi.

get_method_response(http_method, resource_id, restapi_id, status_code)
get_method_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Describes a MethodResponse resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the MethodResponse resource.
• restapi_id: The string identifier of the associated RestApi.
• status_code: The status code for the MethodResponse resource.

get_model(model_name, restapi_id)
get_model(model_name, restapi_id, params::Dict{String,<:Any})

Describes an existing model defined for a RestApi resource.

Arguments

• model_name: The name of the model as an identifier.
• restapi_id: The RestApi identifier under which the Model exists.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "flatten": 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.

get_model_template(model_name, restapi_id)
get_model_template(model_name, restapi_id, params::Dict{String,<:Any})

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Arguments

• model_name: The name of the model for which to generate a template.
• restapi_id: The string identifier of the associated RestApi.

get_models(restapi_id)
get_models(restapi_id, params::Dict{String,<:Any})

Describes existing Models defined for a RestApi resource.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_request_validator(requestvalidator_id, restapi_id)
get_request_validator(requestvalidator_id, restapi_id, params::Dict{String,<:Any})

Gets a RequestValidator of a given RestApi.

Arguments

• requestvalidator_id: The identifier of the RequestValidator to be retrieved.
• restapi_id: The string identifier of the associated RestApi.

get_request_validators(restapi_id)
get_request_validators(restapi_id, params::Dict{String,<:Any})

Gets the RequestValidators collection of a given RestApi.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_resource(resource_id, restapi_id)
get_resource(resource_id, restapi_id, params::Dict{String,<:Any})

Lists information about a resource.

Arguments

• resource_id: The identifier for the Resource resource.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "embed": 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/{restapiid}/resources/{resourceid}?embed=methods.

get_resources(restapi_id)
get_resources(restapi_id, params::Dict{String,<:Any})

Lists information about a collection of Resource resources.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "embed": 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.
• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_rest_api(restapi_id)
get_rest_api(restapi_id, params::Dict{String,<:Any})

Lists the RestApi resource in the collection.

Arguments

• restapi_id: The string identifier of the associated RestApi.

get_rest_apis()
get_rest_apis(params::Dict{String,<:Any})

Lists the RestApis resources for your collection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_sdk(restapi_id, sdk_type, stage_name)
get_sdk(restapi_id, sdk_type, stage_name, params::Dict{String,<:Any})

Generates a client SDK for a RestApi and Stage.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• sdk_type: The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
• stage_name: The name of the Stage that the SDK will use.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "parameters": 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.

get_sdk_type(sdktype_id)
get_sdk_type(sdktype_id, params::Dict{String,<:Any})

Gets an SDK type.

Arguments

• sdktype_id: The identifier of the queried SdkType instance.

get_sdk_types()
get_sdk_types(params::Dict{String,<:Any})

Gets SDK types

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_stage(restapi_id, stage_name)
get_stage(restapi_id, stage_name, params::Dict{String,<:Any})

Gets information about a Stage resource.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the Stage resource to get information about.

get_stages(restapi_id)
get_stages(restapi_id, params::Dict{String,<:Any})

Gets information about one or more Stage resources.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "deploymentId": The stages' deployment identifiers.

get_tags(resource_arn)
get_tags(resource_arn, params::Dict{String,<:Any})

Gets the Tags collection for a given resource.

Arguments

• resource_arn: The ARN of a resource that can be tagged.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": (Not currently supported) The current pagination position in the paged result set.

get_usage(end_date, start_date, usageplan_id)
get_usage(end_date, start_date, usageplan_id, params::Dict{String,<:Any})

Gets the usage data of a usage plan in a specified time interval.

Arguments

• end_date: The ending date (e.g., 2016-12-31) of the usage data.
• start_date: The starting date (e.g., 2016-01-01) of the usage data.
• usageplan_id: The Id of the usage plan associated with the usage data.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "keyId": The Id of the API key associated with the resultant usage data.
• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_usage_plan(usageplan_id)
get_usage_plan(usageplan_id, params::Dict{String,<:Any})

Gets a usage plan of a given plan identifier.

Arguments

• usageplan_id: The identifier of the UsagePlan resource to be retrieved.

get_usage_plan_key(key_id, usageplan_id)
get_usage_plan_key(key_id, usageplan_id, params::Dict{String,<:Any})

Gets a usage plan key of a given key identifier.

Arguments

• key_id: The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
• usageplan_id: The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

get_usage_plan_keys(usageplan_id)
get_usage_plan_keys(usageplan_id, params::Dict{String,<:Any})

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "name": A query parameter specifying the name of the to-be-returned usage plan keys.
• "position": The current pagination position in the paged result set.

get_usage_plans()
get_usage_plans(params::Dict{String,<:Any})

Gets all the usage plans of the caller's account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "keyId": The identifier of the API key associated with the usage plans.
• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

get_vpc_link(vpclink_id)
get_vpc_link(vpclink_id, params::Dict{String,<:Any})

Gets a specified VPC link under the caller's account in a region.

Arguments

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

get_vpc_links()
get_vpc_links(params::Dict{String,<:Any})

Gets the VpcLinks collection under the caller's account in a selected region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "limit": The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
• "position": The current pagination position in the paged result set.

import_api_keys(body, format)
import_api_keys(body, format, params::Dict{String,<:Any})

Import API keys from an external source, such as a CSV-formatted file.

Arguments

• body: The payload of the POST request to import API keys. For the payload format, see API Key File Format.
• format: A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

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

import_documentation_parts(body, restapi_id)
import_documentation_parts(body, restapi_id, params::Dict{String,<:Any})

Imports documentation parts

Arguments

• body: Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "failonwarnings": 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.
• "mode": 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.

import_rest_api(body)
import_rest_api(body, params::Dict{String,<:Any})

A feature of the API Gateway control service for creating a new API from an external API definition file.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "failonwarnings": 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.
• "parameters": 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.

put_gateway_response(response_type, restapi_id)
put_gateway_response(response_type, restapi_id, params::Dict{String,<:Any})

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Arguments

• response_type: The response type of the associated GatewayResponse
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "responseParameters": Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
• "responseTemplates": Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
• "statusCode": The HTTP status code of the GatewayResponse.

put_integration(http_method, resource_id, restapi_id, type)
put_integration(http_method, resource_id, restapi_id, type, params::Dict{String,<:Any})

Sets up a method's integration.

Arguments

• http_method: Specifies the HTTP method for the integration.
• resource_id: Specifies a put integration request's resource ID.
• restapi_id: The string identifier of the associated RestApi.
• type: Specifies a put integration input's type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "cacheKeyParameters": 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.
• "cacheNamespace": 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.
• "connectionId": The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.
• "connectionType": 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.
• "contentHandling": Specifies how to handle request payload content type conversions. Supported values are CONVERTTOBINARY and CONVERTTOTEXT, with the following behaviors: 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.
• "credentials": Specifies whether credentials are required for a put integration.
• "httpMethod": The HTTP method for the integration.
• "passthroughBehavior": 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: WHENNOMATCH, WHENNOTEMPLATES, and NEVER.
• "requestParameters": 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.
• "requestTemplates": 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.
• "timeoutInMillis": Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
• "tlsConfig":
• "uri": Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTPPROXY 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 VPCLINK, or private integration, where connectionType is VPCLINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWSPROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{serviceapi}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {serviceapi} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services 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}.

put_integration_response(http_method, resource_id, restapi_id, status_code)
put_integration_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Represents a put integration.

Arguments

• http_method: Specifies a put integration response request's HTTP method.
• resource_id: Specifies a put integration response request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.
• status_code: Specifies the status code that is used to map the integration response to an existing MethodResponse.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "contentHandling": Specifies how to handle response payload content type conversions. Supported values are CONVERTTOBINARY and CONVERTTOTEXT, with the following behaviors: If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
• "responseParameters": 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.
• "responseTemplates": Specifies a put integration response's templates.
• "selectionPattern": Specifies the selection pattern of a put integration response.

put_method(authorization_type, http_method, resource_id, restapi_id)
put_method(authorization_type, http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Add a method to an existing Resource resource.

Arguments

• authorization_type: The method's authorization type. Valid values are NONE for open access, AWSIAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITOUSER_POOLS for using a Cognito user pool.
• http_method: Specifies the method request's HTTP method type.
• resource_id: The Resource identifier for the new Method resource.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "apiKeyRequired": Specifies whether the method required a valid ApiKey.
• "authorizationScopes": A list of authorization scopes configured on the method. The scopes are used with a COGNITOUSERPOOLS 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.
• "authorizerId": Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITOUSERPOOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
• "operationName": 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.
• "requestModels": 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.
• "requestParameters": 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.
• "requestValidatorId": The identifier of a RequestValidator for validating the method request.

put_method_response(http_method, resource_id, restapi_id, status_code)
put_method_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Adds a MethodResponse to an existing Method resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the Method resource.
• restapi_id: The string identifier of the associated RestApi.
• status_code: The method response's status code.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "responseModels": 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.
• "responseParameters": 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.)

put_rest_api(body, restapi_id)
put_rest_api(body, restapi_id, params::Dict{String,<:Any})

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Arguments

• body: 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_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "failonwarnings": 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.
• "mode": The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
• "parameters": 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'.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds or updates a tag on a given resource.

Arguments

• resource_arn: The ARN of a resource that can be tagged.
• tags: 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.

test_invoke_authorizer(authorizer_id, restapi_id)
test_invoke_authorizer(authorizer_id, restapi_id, params::Dict{String,<:Any})

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Arguments

• authorizer_id: Specifies a test invoke authorizer request's Authorizer ID.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "additionalContext": A key-value map of additional context variables.
• "body": The simulated request body of an incoming invocation request.
• "headers": 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.
• "multiValueHeaders": 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.
• "pathWithQueryString": The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
• "stageVariables": A key-value map of stage variables to simulate an invocation on a deployed Stage.

test_invoke_method(http_method, resource_id, restapi_id)
test_invoke_method(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

Arguments

• http_method: Specifies a test invoke method request's HTTP method.
• resource_id: Specifies a test invoke method request's resource ID.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "body": The simulated request body of an incoming invocation request.
• "clientCertificateId": 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.
• "headers": A key-value map of headers to simulate an incoming invocation request.
• "multiValueHeaders": The headers as a map from string to list of values to simulate an incoming invocation request.
• "pathWithQueryString": The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
• "stageVariables": A key-value map of stage variables to simulate an invocation on a deployed Stage.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag from a given resource.

Arguments

• resource_arn: The ARN of a resource that can be tagged.
• tag_keys: The Tag keys to delete.

update_account()
update_account(params::Dict{String,<:Any})

Changes information about the current Account resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_api_key(api__key)
update_api_key(api__key, params::Dict{String,<:Any})

Changes information about an ApiKey resource.

Arguments

• api__key: The identifier of the ApiKey resource to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_authorizer(authorizer_id, restapi_id)
update_authorizer(authorizer_id, restapi_id, params::Dict{String,<:Any})

Updates an existing Authorizer resource.

Arguments

• authorizer_id: The identifier of the Authorizer resource.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_base_path_mapping(base_path, domain_name)
update_base_path_mapping(base_path, domain_name, params::Dict{String,<:Any})

Changes information about the BasePathMapping resource.

Arguments

• base_path: The base path of the BasePathMapping resource to change. To specify an empty base path, set this parameter to '(none)'.
• domain_name: The domain name of the BasePathMapping resource to change.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_client_certificate(clientcertificate_id)
update_client_certificate(clientcertificate_id, params::Dict{String,<:Any})

Changes information about an ClientCertificate resource.

Arguments

• clientcertificate_id: The identifier of the ClientCertificate resource to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_deployment(deployment_id, restapi_id)
update_deployment(deployment_id, restapi_id, params::Dict{String,<:Any})

Changes information about a Deployment resource.

Arguments

• deployment_id: The replacement identifier for the Deployment resource to change information about.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_documentation_part(part_id, restapi_id)
update_documentation_part(part_id, restapi_id, params::Dict{String,<:Any})

Updates a documentation part.

Arguments

• part_id: The identifier of the to-be-updated documentation part.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_documentation_version(doc_version, restapi_id)
update_documentation_version(doc_version, restapi_id, params::Dict{String,<:Any})

Updates a documentation version.

Arguments

• doc_version: The version identifier of the to-be-updated documentation version.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_domain_name(domain_name)
update_domain_name(domain_name, params::Dict{String,<:Any})

Changes information about the DomainName resource.

Arguments

• domain_name: The name of the DomainName resource to be changed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_gateway_response(response_type, restapi_id)
update_gateway_response(response_type, restapi_id, params::Dict{String,<:Any})

Updates a GatewayResponse of a specified response type on the given RestApi.

Arguments

• response_type: The response type of the associated GatewayResponse.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_integration(http_method, resource_id, restapi_id)
update_integration(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Represents an update integration.

Arguments

• http_method: Represents an update integration request's HTTP method.
• resource_id: Represents an update integration request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_integration_response(http_method, resource_id, restapi_id, status_code)
update_integration_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Represents an update integration response.

Arguments

• http_method: Specifies an update integration response request's HTTP method.
• resource_id: Specifies an update integration response request's resource identifier.
• restapi_id: The string identifier of the associated RestApi.
• status_code: Specifies an update integration response request's status code.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_method(http_method, resource_id, restapi_id)
update_method(http_method, resource_id, restapi_id, params::Dict{String,<:Any})

Updates an existing Method resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the Method resource.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_method_response(http_method, resource_id, restapi_id, status_code)
update_method_response(http_method, resource_id, restapi_id, status_code, params::Dict{String,<:Any})

Updates an existing MethodResponse resource.

Arguments

• http_method: The HTTP verb of the Method resource.
• resource_id: The Resource identifier for the MethodResponse resource.
• restapi_id: The string identifier of the associated RestApi.
• status_code: The status code for the MethodResponse resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_model(model_name, restapi_id)
update_model(model_name, restapi_id, params::Dict{String,<:Any})

Changes information about a model. The maximum size of the model is 400 KB.

Arguments

• model_name: The name of the model to update.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_request_validator(requestvalidator_id, restapi_id)
update_request_validator(requestvalidator_id, restapi_id, params::Dict{String,<:Any})

Updates a RequestValidator of a given RestApi.

Arguments

• requestvalidator_id: The identifier of RequestValidator to be updated.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_resource(resource_id, restapi_id)
update_resource(resource_id, restapi_id, params::Dict{String,<:Any})

Changes information about a Resource resource.

Arguments

• resource_id: The identifier of the Resource resource.
• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_rest_api(restapi_id)
update_rest_api(restapi_id, params::Dict{String,<:Any})

Changes information about the specified API.

Arguments

• restapi_id: The string identifier of the associated RestApi.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_stage(restapi_id, stage_name)
update_stage(restapi_id, stage_name, params::Dict{String,<:Any})

Changes information about a Stage resource.

Arguments

• restapi_id: The string identifier of the associated RestApi.
• stage_name: The name of the Stage resource to change information about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_usage(key_id, usageplan_id)
update_usage(key_id, usageplan_id, params::Dict{String,<:Any})

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Arguments

• key_id: The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
• usageplan_id: The Id of the usage plan associated with the usage data.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_usage_plan(usageplan_id)
update_usage_plan(usageplan_id, params::Dict{String,<:Any})

Updates a usage plan of a given plan Id.

Arguments

• usageplan_id: The Id of the to-be-updated usage plan.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.

update_vpc_link(vpclink_id)
update_vpc_link(vpclink_id, params::Dict{String,<:Any})

Updates an existing VpcLink of a specified identifier.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "patchOperations": For more information about supported patch operations, see Patch Operations.