You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon API Gateway. To construct a client, you need to configure a :region and :credentials.

apigateway = Aws::APIGateway::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::APIGateway::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::APIGateway::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_api_key(options = {}) ⇒ Types::ApiKey

Create an ApiKey resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.create_api_key({
  name: "String",
  description: "String",
  enabled: false,
  generate_distinct_id: false,
  value: "String",
  stage_keys: [
    {
      rest_api_id: "String",
      stage_name: "String",
    },
  ],
  customer_id: "String",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> true/false
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :name (String) —

    The name of the ApiKey.

  • :description (String) —

    The description of the ApiKey.

  • :enabled (Boolean) —

    Specifies whether the ApiKey can be used by callers.

  • :generate_distinct_id (Boolean) —

    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.

  • :value (String) —

    Specifies a value of the API key.

  • :stage_keys (Array<Types::StageKey>) —

    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

  • :customer_id (String) —

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

  • :tags (Hash<String,String>) —

    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.

Returns:

#create_authorizer(options = {}) ⇒ Types::Authorizer

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.create_authorizer({
  rest_api_id: "String", # required
  name: "String", # required
  type: "TOKEN", # required, accepts TOKEN, REQUEST, COGNITO_USER_POOLS
  provider_arns: ["ProviderARN"],
  auth_type: "String",
  authorizer_uri: "String",
  authorizer_credentials: "String",
  identity_source: "String",
  identity_validation_expression: "String",
  authorizer_result_ttl_in_seconds: 1,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :name (required, String) —

    [Required] The name of the authorizer.

  • :type (required, String) —

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

  • :provider_arns (Array<String>) —

    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.

  • :auth_type (String) —

    Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

  • :authorizer_uri (String) —

    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_credentials (String) —

    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.

  • :identity_source (String) —

    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.

  • :identity_validation_expression (String) —

    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_result_ttl_in_seconds (Integer) —

    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.

Returns:

#create_base_path_mapping(options = {}) ⇒ Types::BasePathMapping

Creates a new BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.create_base_path_mapping({
  domain_name: "String", # required
  base_path: "String",
  rest_api_id: "String", # required
  stage: "String",
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The domain name of the BasePathMapping resource to create.

  • :base_path (String) —

    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.

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage (String) —

    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.

Returns:

#create_deployment(options = {}) ⇒ Types::Deployment

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

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  rest_api_id: "String", # required
  stage_name: "String",
  stage_description: "String",
  description: "String",
  cache_cluster_enabled: false,
  cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
  variables: {
    "String" => "String",
  },
  canary_settings: {
    percent_traffic: 1.0,
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
  tracing_enabled: false,
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (String) —

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

  • :stage_description (String) —

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

  • :description (String) —

    The description for the Deployment resource to create.

  • :cache_cluster_enabled (Boolean) —

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

  • :cache_cluster_size (String) —

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

  • :variables (Hash<String,String>) —

    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-._~:/?#&=,]+.

  • :canary_settings (Types::DeploymentCanarySettings) —

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

  • :tracing_enabled (Boolean) —

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

Returns:

#create_documentation_part(options = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.create_documentation_part({
  rest_api_id: "String", # required
  location: { # required
    type: "API", # required, accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
    path: "String",
    method: "String",
    status_code: "DocumentationPartLocationStatusCode",
    name: "String",
  },
  properties: "String", # required
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :location (required, Types::DocumentationPartLocation) —

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

  • :properties (required, String) —

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

Returns:

#create_documentation_version(options = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.create_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
  stage_name: "String",
  description: "String",
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

    [Required] The version identifier of the new snapshot.

  • :stage_name (String) —

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

  • :description (String) —

    A description about the new documentation snapshot.

Returns:

#create_domain_name(options = {}) ⇒ Types::DomainName

Creates a new domain name.

Examples:

Request syntax with placeholder values


resp = client.create_domain_name({
  domain_name: "String", # required
  certificate_name: "String",
  certificate_body: "String",
  certificate_private_key: "String",
  certificate_chain: "String",
  certificate_arn: "String",
  regional_certificate_name: "String",
  regional_certificate_arn: "String",
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
    vpc_endpoint_ids: ["String"],
  },
  tags: {
    "String" => "String",
  },
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
  mutual_tls_authentication: {
    truststore_uri: "String",
    truststore_version: "String",
  },
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.regional_domain_name #=> String
resp.regional_hosted_zone_id #=> String
resp.regional_certificate_name #=> String
resp.regional_certificate_arn #=> String
resp.distribution_domain_name #=> String
resp.distribution_hosted_zone_id #=> String
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The name of the DomainName resource.

  • :certificate_name (String) —

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

  • :certificate_body (String) —

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

  • :certificate_private_key (String) —

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

  • :certificate_chain (String) —

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

  • :certificate_arn (String) —

    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.

  • :regional_certificate_name (String) —

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

  • :regional_certificate_arn (String) —

    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.

  • :endpoint_configuration (Types::EndpointConfiguration) —

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

  • :tags (Hash<String,String>) —

    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.

  • :security_policy (String) —

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

  • :mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

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

Returns:

#create_model(options = {}) ⇒ Types::Model

Adds a new Model resource to an existing RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.create_model({
  rest_api_id: "String", # required
  name: "String", # required
  description: "String",
  schema: "String",
  content_type: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.schema #=> String
resp.content_type #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

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

  • :name (required, String) —

    [Required] The name of the model. Must be alphanumeric.

  • :description (String) —

    The description of the model.

  • :schema (String) —

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

  • :content_type (required, String) —

    [Required] The content-type for the model.

Returns:

#create_request_validator(options = {}) ⇒ Types::RequestValidator

Creates a ReqeustValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.create_request_validator({
  rest_api_id: "String", # required
  name: "String",
  validate_request_body: false,
  validate_request_parameters: false,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.validate_request_body #=> true/false
resp.validate_request_parameters #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :name (String) —

    The name of the to-be-created RequestValidator.

  • :validate_request_body (Boolean) —

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

  • :validate_request_parameters (Boolean) —

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

Returns:

#create_resource(options = {}) ⇒ Types::Resource

Creates a Resource resource.

Examples:

Request syntax with placeholder values


resp = client.create_resource({
  rest_api_id: "String", # required
  parent_id: "String", # required
  path_part: "String", # required
})

Response structure


resp.id #=> String
resp.parent_id #=> String
resp.path_part #=> String
resp.path #=> String
resp.resource_methods #=> Hash
resp.resource_methods["String"].http_method #=> String
resp.resource_methods["String"].authorization_type #=> String
resp.resource_methods["String"].authorizer_id #=> String
resp.resource_methods["String"].api_key_required #=> true/false
resp.resource_methods["String"].request_validator_id #=> String
resp.resource_methods["String"].operation_name #=> String
resp.resource_methods["String"].request_parameters #=> Hash
resp.resource_methods["String"].request_parameters["String"] #=> true/false
resp.resource_methods["String"].request_models #=> Hash
resp.resource_methods["String"].request_models["String"] #=> String
resp.resource_methods["String"].method_responses #=> Hash
resp.resource_methods["String"].method_responses["String"].status_code #=> String
resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> true/false
resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.resource_methods["String"].method_integration.http_method #=> String
resp.resource_methods["String"].method_integration.uri #=> String
resp.resource_methods["String"].method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.resource_methods["String"].method_integration.connection_id #=> String
resp.resource_methods["String"].method_integration.credentials #=> String
resp.resource_methods["String"].method_integration.request_parameters #=> Hash
resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.request_templates #=> Hash
resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.timeout_in_millis #=> Integer
resp.resource_methods["String"].method_integration.cache_namespace #=> String
resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.resource_methods["String"].method_integration.integration_responses #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.tls_config.insecure_skip_verification #=> true/false
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :parent_id (required, String) —

    [Required] The parent resource\'s identifier.

  • :path_part (required, String) —

    The last path segment for this resource.

Returns:

#create_rest_api(options = {}) ⇒ Types::RestApi

Creates a new RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.create_rest_api({
  name: "String", # required
  description: "String",
  version: "String",
  clone_from: "String",
  binary_media_types: ["String"],
  minimum_compression_size: 1,
  api_key_source: "HEADER", # accepts HEADER, AUTHORIZER
  endpoint_configuration: {
    types: ["REGIONAL"], # accepts REGIONAL, EDGE, PRIVATE
    vpc_endpoint_ids: ["String"],
  },
  policy: "String",
  tags: {
    "String" => "String",
  },
  disable_execute_api_endpoint: false,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :name (required, String) —

    [Required] The name of the RestApi.

  • :description (String) —

    The description of the RestApi.

  • :version (String) —

    A version identifier for the API.

  • :clone_from (String) —

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

  • :binary_media_types (Array<String>) —

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

  • :minimum_compression_size (Integer) —

    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.

  • :api_key_source (String) —

    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.

  • :endpoint_configuration (Types::EndpointConfiguration) —

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

  • :policy (String) —

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

  • :tags (Hash<String,String>) —

    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.

  • :disable_execute_api_endpoint (Boolean) —

    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" target="_parent" title="api_id">https://`{api_id</a>">api_id">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.

Returns:

#create_stage(options = {}) ⇒ Types::Stage

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

Examples:

Request syntax with placeholder values


resp = client.create_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
  deployment_id: "String", # required
  description: "String",
  cache_cluster_enabled: false,
  cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
  variables: {
    "String" => "String",
  },
  documentation_version: "String",
  canary_settings: {
    percent_traffic: 1.0,
    deployment_id: "String",
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
  tracing_enabled: false,
  tags: {
    "String" => "String",
  },
})

Response structure


resp.deployment_id #=> String
resp.client_certificate_id #=> String
resp.stage_name #=> String
resp.description #=> String
resp.cache_cluster_enabled #=> true/false
resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.method_settings #=> Hash
resp.method_settings["String"].metrics_enabled #=> true/false
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> true/false
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> true/false
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> true/false
resp.method_settings["String"].require_authorization_for_cache_control #=> true/false
resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.variables #=> Hash
resp.variables["String"] #=> String
resp.documentation_version #=> String
resp.access_log_settings.format #=> String
resp.access_log_settings.destination_arn #=> String
resp.canary_settings.percent_traffic #=> Float
resp.canary_settings.deployment_id #=> String
resp.canary_settings.stage_variable_overrides #=> Hash
resp.canary_settings.stage_variable_overrides["String"] #=> String
resp.canary_settings.use_stage_cache #=> true/false
resp.tracing_enabled #=> true/false
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

  • :deployment_id (required, String) —

    [Required] The identifier of the Deployment resource for the Stage resource.

  • :description (String) —

    The description of the Stage resource.

  • :cache_cluster_enabled (Boolean) —

    Whether cache clustering is enabled for the stage.

  • :cache_cluster_size (String) —

    The stage\'s cache cluster size.

  • :variables (Hash<String,String>) —

    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-._~:/?#&=,]+.

  • :documentation_version (String) —

    The version of the associated API documentation.

  • :canary_settings (Types::CanarySettings) —

    The canary deployment settings of this stage.

  • :tracing_enabled (Boolean) —

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

  • :tags (Hash<String,String>) —

    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.

Returns:

#create_usage_plan(options = {}) ⇒ Types::UsagePlan

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

Examples:

Request syntax with placeholder values


resp = client.create_usage_plan({
  name: "String", # required
  description: "String",
  api_stages: [
    {
      api_id: "String",
      stage: "String",
      throttle: {
        "String" => {
          burst_limit: 1,
          rate_limit: 1.0,
        },
      },
    },
  ],
  throttle: {
    burst_limit: 1,
    rate_limit: 1.0,
  },
  quota: {
    limit: 1,
    offset: 1,
    period: "DAY", # accepts DAY, WEEK, MONTH
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.api_stages #=> Array
resp.api_stages[0].api_id #=> String
resp.api_stages[0].stage #=> String
resp.api_stages[0].throttle #=> Hash
resp.api_stages[0].throttle["String"].burst_limit #=> Integer
resp.api_stages[0].throttle["String"].rate_limit #=> Float
resp.throttle.burst_limit #=> Integer
resp.throttle.rate_limit #=> Float
resp.quota.limit #=> Integer
resp.quota.offset #=> Integer
resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.product_code #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :name (required, String) —

    [Required] The name of the usage plan.

  • :description (String) —

    The description of the usage plan.

  • :api_stages (Array<Types::ApiStage>) —

    The associated API stages of the usage plan.

  • :throttle (Types::ThrottleSettings) —

    The throttling limits of the usage plan.

  • :quota (Types::QuotaSettings) —

    The quota of the usage plan.

  • :tags (Hash<String,String>) —

    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.

Returns:

#create_usage_plan_key(options = {}) ⇒ Types::UsagePlanKey

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

Examples:

Request syntax with placeholder values


resp = client.create_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
  key_type: "String", # required
})

Response structure


resp.id #=> String
resp.type #=> String
resp.value #=> String
resp.name #=> String

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :key_id (required, String) —

    [Required] The identifier of a UsagePlanKey resource for a plan customer.

  • :key_type (required, String) —

    [Required] The type of a UsagePlanKey resource for a plan customer.

Returns:

#create_vpc_link(options = {}) ⇒ Types::VpcLink

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.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_link({
  name: "String", # required
  description: "String",
  target_arns: ["String"], # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.target_arns #=> Array
resp.target_arns[0] #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.status_message #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :name (required, String) —

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

  • :description (String) —

    The description of the VPC link.

  • :target_arns (required, Array<String>) —

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

  • :tags (Hash<String,String>) —

    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.

Returns:

#delete_api_key(options = {}) ⇒ Struct

Deletes the ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.delete_api_key({
  api_key: "String", # required
})

Options Hash (options):

  • :api_key (required, String) —

    [Required] The identifier of the ApiKey resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_authorizer(options = {}) ⇒ Struct

Deletes an existing Authorizer resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.delete_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    [Required] The identifier of the Authorizer resource.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_base_path_mapping(options = {}) ⇒ Struct

Deletes the BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.delete_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
})

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The domain name of the BasePathMapping resource to delete.

  • :base_path (required, String) —

    [Required] The base path name of the BasePathMapping resource to delete.

    To specify an empty base path, set this parameter to '(none)'.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_client_certificate(options = {}) ⇒ Struct

Deletes the ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.delete_client_certificate({
  client_certificate_id: "String", # required
})

Options Hash (options):

  • :client_certificate_id (required, String) —

    [Required] The identifier of the ClientCertificate resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_deployment(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (required, String) —

    [Required] The identifier of the Deployment resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_documentation_part(options = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.delete_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

#delete_documentation_version(options = {}) ⇒ Struct

Returns an empty response.

Examples:

Request syntax with placeholder values


resp = client.delete_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

    [Required] The version identifier of a to-be-deleted documentation snapshot.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_domain_name(options = {}) ⇒ Struct

Deletes the DomainName resource.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_name({
  domain_name: "String", # required
})

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The name of the DomainName resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_gateway_response(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String) —

    [Required] The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE

Returns:

  • (Struct) —

    Returns an empty response.

#delete_integration(options = {}) ⇒ Struct

Represents a delete integration.

Examples:

Request syntax with placeholder values


resp = client.delete_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] Specifies a delete integration request\'s resource identifier.

  • :http_method (required, String) —

    [Required] Specifies a delete integration request\'s HTTP method.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_integration_response(options = {}) ⇒ Struct

Represents a delete integration response.

Examples:

Request syntax with placeholder values


resp = client.delete_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

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

  • :http_method (required, String) —

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

  • :status_code (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

#delete_method(options = {}) ⇒ Struct

Deletes an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.delete_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_method_response(options = {}) ⇒ Struct

Deletes an existing MethodResponse resource.

Examples:

Request syntax with placeholder values


resp = client.delete_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String) —

    [Required] The status code identifier for the MethodResponse resource.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_model(options = {}) ⇒ Struct

Deletes a model.

Examples:

Request syntax with placeholder values


resp = client.delete_model({
  rest_api_id: "String", # required
  model_name: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :model_name (required, String) —

    [Required] The name of the model to delete.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_request_validator(options = {}) ⇒ Struct

Deletes a RequestValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.delete_request_validator({
  rest_api_id: "String", # required
  request_validator_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    [Required] The identifier of the RequestValidator to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_resource(options = {}) ⇒ Struct

Deletes a Resource resource.

Examples:

Request syntax with placeholder values


resp = client.delete_resource({
  rest_api_id: "String", # required
  resource_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The identifier of the Resource resource.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_rest_api(options = {}) ⇒ Struct

Deletes the specified API.

Examples:

Request syntax with placeholder values


resp = client.delete_rest_api({
  rest_api_id: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_stage(options = {}) ⇒ Struct

Deletes a Stage resource.

Examples:

Request syntax with placeholder values


resp = client.delete_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name of the Stage resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_usage_plan(options = {}) ⇒ Struct

Deletes a usage plan of a given plan Id.

Examples:

Request syntax with placeholder values


resp = client.delete_usage_plan({
  usage_plan_id: "String", # required
})

Options Hash (options):

  • :usage_plan_id (required, String) —

    [Required] The Id of the to-be-deleted usage plan.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_usage_plan_key(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
})

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :key_id (required, String) —

    [Required] The Id of the UsagePlanKey resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

#delete_vpc_link(options = {}) ⇒ Struct

Deletes an existing VpcLink of a specified identifier.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_link({
  vpc_link_id: "String", # required
})

Options Hash (options):

  • :vpc_link_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

#flush_stage_authorizers_cache(options = {}) ⇒ Struct

Flushes all authorizer cache entries on a stage.

Examples:

Request syntax with placeholder values


resp = client.flush_stage_authorizers_cache({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the stage to flush.

Returns:

  • (Struct) —

    Returns an empty response.

#flush_stage_cache(options = {}) ⇒ Struct

Flushes a stage's cache.

Examples:

Request syntax with placeholder values


resp = client.flush_stage_cache({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name of the stage to flush its cache.

Returns:

  • (Struct) —

    Returns an empty response.

#generate_client_certificate(options = {}) ⇒ Types::ClientCertificate

Generates a ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.generate_client_certificate({
  description: "String",
  tags: {
    "String" => "String",
  },
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :description (String) —

    The description of the ClientCertificate.

  • :tags (Hash<String,String>) —

    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.

Returns:

#get_account(options = {}) ⇒ Types::Account

Gets information about the current Account resource.

Examples:

Request syntax with placeholder values


resp = client.()

Response structure


resp.cloudwatch_role_arn #=> String
resp.throttle_settings.burst_limit #=> Integer
resp.throttle_settings.rate_limit #=> Float
resp.features #=> Array
resp.features[0] #=> String
resp.api_key_version #=> String

Returns:

#get_api_key(options = {}) ⇒ Types::ApiKey

Gets information about the current ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.get_api_key({
  api_key: "String", # required
  include_value: false,
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> true/false
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :api_key (required, String) —

    [Required] The identifier of the ApiKey resource.

  • :include_value (Boolean) —

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

Returns:

#get_api_keys(options = {}) ⇒ Types::ApiKeys

Gets information about the current ApiKeys resource.

Examples:

Request syntax with placeholder values


resp = client.get_api_keys({
  position: "String",
  limit: 1,
  name_query: "String",
  customer_id: "String",
  include_values: false,
})

Response structure


resp.warnings #=> Array
resp.warnings[0] #=> String
resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].value #=> String
resp.items[0].name #=> String
resp.items[0].customer_id #=> String
resp.items[0].description #=> String
resp.items[0].enabled #=> true/false
resp.items[0].created_date #=> Time
resp.items[0].last_updated_date #=> Time
resp.items[0].stage_keys #=> Array
resp.items[0].stage_keys[0] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

  • :name_query (String) —

    The name of queried API keys.

  • :customer_id (String) —

    The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

  • :include_values (Boolean) —

    A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:

#get_authorizer(options = {}) ⇒ Types::Authorizer

Describe an existing Authorizer resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.get_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    [Required] The identifier of the Authorizer resource.

Returns:

#get_authorizers(options = {}) ⇒ Types::Authorizers

Describe an existing Authorizers resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.get_authorizers({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
resp.items[0].provider_arns #=> Array
resp.items[0].provider_arns[0] #=> String
resp.items[0].auth_type #=> String
resp.items[0].authorizer_uri #=> String
resp.items[0].authorizer_credentials #=> String
resp.items[0].identity_source #=> String
resp.items[0].identity_validation_expression #=> String
resp.items[0].authorizer_result_ttl_in_seconds #=> Integer

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_base_path_mapping(options = {}) ⇒ Types::BasePathMapping

Describe a BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.get_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Options Hash (options):

  • :domain_name (required, String) —

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

  • :base_path (required, String) —

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

Returns:

#get_base_path_mappings(options = {}) ⇒ Types::BasePathMappings

Represents a collection of BasePathMapping resources.

Examples:

Request syntax with placeholder values


resp = client.get_base_path_mappings({
  domain_name: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].base_path #=> String
resp.items[0].rest_api_id #=> String
resp.items[0].stage #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The domain name of a BasePathMapping resource.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_client_certificate(options = {}) ⇒ Types::ClientCertificate

Gets information about the current ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.get_client_certificate({
  client_certificate_id: "String", # required
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :client_certificate_id (required, String) —

    [Required] The identifier of the ClientCertificate resource to be described.

Returns:

#get_client_certificates(options = {}) ⇒ Types::ClientCertificates

Gets a collection of ClientCertificate resources.

Examples:

Request syntax with placeholder values


resp = client.get_client_certificates({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].client_certificate_id #=> String
resp.items[0].description #=> String
resp.items[0].pem_encoded_certificate #=> String
resp.items[0].created_date #=> Time
resp.items[0].expiration_date #=> Time
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_deployment(options = {}) ⇒ Types::Deployment

Gets information about a Deployment resource.

Examples:

Request syntax with placeholder values


resp = client.get_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
  embed: ["String"],
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (required, String) —

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

  • :embed (Array<String>) —

    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 .

Returns:

#get_deployments(options = {}) ⇒ Types::Deployments

Gets information about a Deployments collection.

Examples:

Request syntax with placeholder values


resp = client.get_deployments({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].description #=> String
resp.items[0].created_date #=> Time
resp.items[0].api_summary #=> Hash
resp.items[0].api_summary["String"] #=> Hash
resp.items[0].api_summary["String"]["String"].authorization_type #=> String
resp.items[0].api_summary["String"]["String"].api_key_required #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_documentation_part(options = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

    [Required] The string identifier of the associated RestApi.

Returns:

#get_documentation_parts(options = {}) ⇒ Types::DocumentationParts

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_parts({
  rest_api_id: "String", # required
  type: "API", # accepts API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
  name_query: "String",
  path: "String",
  position: "String",
  limit: 1,
  location_status: "DOCUMENTED", # accepts DOCUMENTED, UNDOCUMENTED
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.items[0].location.path #=> String
resp.items[0].location.method #=> String
resp.items[0].location.status_code #=> String
resp.items[0].location.name #=> String
resp.items[0].properties #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :type (String) —

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

  • :name_query (String) —

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

  • :path (String) —

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

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

  • :location_status (String) —

    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.

Returns:

#get_documentation_version(options = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

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

Returns:

#get_documentation_versions(options = {}) ⇒ Types::DocumentationVersions

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_documentation_versions({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].version #=> String
resp.items[0].created_date #=> Time
resp.items[0].description #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_domain_name(options = {}) ⇒ Types::DomainName

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

Examples:

Request syntax with placeholder values


resp = client.get_domain_name({
  domain_name: "String", # required
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.regional_domain_name #=> String
resp.regional_hosted_zone_id #=> String
resp.regional_certificate_name #=> String
resp.regional_certificate_arn #=> String
resp.distribution_domain_name #=> String
resp.distribution_hosted_zone_id #=> String
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The name of the DomainName resource.

Returns:

#get_domain_names(options = {}) ⇒ Types::DomainNames

Represents a collection of DomainName resources.

Examples:

Request syntax with placeholder values


resp = client.get_domain_names({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].certificate_name #=> String
resp.items[0].certificate_arn #=> String
resp.items[0].certificate_upload_date #=> Time
resp.items[0].regional_domain_name #=> String
resp.items[0].regional_hosted_zone_id #=> String
resp.items[0].regional_certificate_name #=> String
resp.items[0].regional_certificate_arn #=> String
resp.items[0].distribution_domain_name #=> String
resp.items[0].distribution_hosted_zone_id #=> String
resp.items[0].endpoint_configuration.types #=> Array
resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.items[0].endpoint_configuration.vpc_endpoint_ids #=> Array
resp.items[0].endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.items[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
resp.items[0].domain_name_status_message #=> String
resp.items[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String
resp.items[0].mutual_tls_authentication.truststore_uri #=> String
resp.items[0].mutual_tls_authentication.truststore_version #=> String
resp.items[0].mutual_tls_authentication.truststore_warnings #=> Array
resp.items[0].mutual_tls_authentication.truststore_warnings[0] #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_export(options = {}) ⇒ Types::ExportResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_export({
  rest_api_id: "String", # required
  stage_name: "String", # required
  export_type: "String", # required
  parameters: {
    "String" => "String",
  },
  accepts: "String",
})

Response structure


resp.content_type #=> String
resp.content_disposition #=> String
resp.body #=> IO

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name of the Stage that will be exported.

  • :export_type (required, String) —

    [Required] The type of export. Acceptable values are \'oas30\' for OpenAPI 3.0.x and \'swagger\' for Swagger/OpenAPI 2.0.

  • :parameters (Hash<String,String>) —

    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

  • :accepts (String) —

    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.

Returns:

#get_gateway_response(options = {}) ⇒ Types::GatewayResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String) —

    [Required] The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE

Returns:

#get_gateway_responses(options = {}) ⇒ Types::GatewayResponses

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.

Examples:

Request syntax with placeholder values


resp = client.get_gateway_responses({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.items[0].status_code #=> String
resp.items[0].response_parameters #=> Hash
resp.items[0].response_parameters["String"] #=> String
resp.items[0].response_templates #=> Hash
resp.items[0].response_templates["String"] #=> String
resp.items[0].default_response #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

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

  • :limit (Integer) —

    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.

Returns:

#get_integration(options = {}) ⇒ Types::Integration

Get the integration settings.

Examples:

Request syntax with placeholder values


resp = client.get_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.connection_id #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.timeout_in_millis #=> Integer
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].response_parameters #=> Hash
resp.integration_responses["String"].response_parameters["String"] #=> String
resp.integration_responses["String"].response_templates #=> Hash
resp.integration_responses["String"].response_templates["String"] #=> String
resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.tls_config.insecure_skip_verification #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] Specifies a get integration request\'s resource identifier

  • :http_method (required, String) —

    [Required] Specifies a get integration request\'s HTTP method.

Returns:

#get_integration_response(options = {}) ⇒ Types::IntegrationResponse

Represents a get integration response.

Examples:

Request syntax with placeholder values


resp = client.get_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Response structure


resp.status_code #=> String
resp.selection_pattern #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

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

  • :http_method (required, String) —

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

  • :status_code (required, String) —

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

Returns:

#get_method(options = {}) ⇒ Types::Method

Describe an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.get_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
})

Response structure


resp.http_method #=> String
resp.authorization_type #=> String
resp.authorizer_id #=> String
resp.api_key_required #=> true/false
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> true/false
resp.request_models #=> Hash
resp.request_models["String"] #=> String
resp.method_responses #=> Hash
resp.method_responses["String"].status_code #=> String
resp.method_responses["String"].response_parameters #=> Hash
resp.method_responses["String"].response_parameters["String"] #=> true/false
resp.method_responses["String"].response_models #=> Hash
resp.method_responses["String"].response_models["String"] #=> String
resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.method_integration.http_method #=> String
resp.method_integration.uri #=> String
resp.method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.method_integration.connection_id #=> String
resp.method_integration.credentials #=> String
resp.method_integration.request_parameters #=> Hash
resp.method_integration.request_parameters["String"] #=> String
resp.method_integration.request_templates #=> Hash
resp.method_integration.request_templates["String"] #=> String
resp.method_integration.passthrough_behavior #=> String
resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.timeout_in_millis #=> Integer
resp.method_integration.cache_namespace #=> String
resp.method_integration.cache_key_parameters #=> Array
resp.method_integration.cache_key_parameters[0] #=> String
resp.method_integration.integration_responses #=> Hash
resp.method_integration.integration_responses["String"].status_code #=> String
resp.method_integration.integration_responses["String"].selection_pattern #=> String
resp.method_integration.integration_responses["String"].response_parameters #=> Hash
resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.method_integration.integration_responses["String"].response_templates #=> Hash
resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.tls_config.insecure_skip_verification #=> true/false
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String) —

    [Required] Specifies the method request\'s HTTP method type.

Returns:

#get_method_response(options = {}) ⇒ Types::MethodResponse

Describes a MethodResponse resource.

Examples:

Request syntax with placeholder values


resp = client.get_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
})

Response structure


resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> true/false
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String) —

    [Required] The status code for the MethodResponse resource.

Returns:

#get_model(options = {}) ⇒ Types::Model

Describes an existing model defined for a RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.get_model({
  rest_api_id: "String", # required
  model_name: "String", # required
  flatten: false,
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.schema #=> String
resp.content_type #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The RestApi identifier under which the Model exists.

  • :model_name (required, String) —

    [Required] The name of the model as an identifier.

  • :flatten (Boolean) —

    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.

Returns:

#get_model_template(options = {}) ⇒ Types::Template

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

Examples:

Request syntax with placeholder values


resp = client.get_model_template({
  rest_api_id: "String", # required
  model_name: "String", # required
})

Response structure


resp.value #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :model_name (required, String) —

    [Required] The name of the model for which to generate a template.

Returns:

#get_models(options = {}) ⇒ Types::Models

Describes existing Models defined for a RestApi resource.

Examples:

Request syntax with placeholder values


resp = client.get_models({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].schema #=> String
resp.items[0].content_type #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_request_validator(options = {}) ⇒ Types::RequestValidator

Gets a RequestValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.get_request_validator({
  rest_api_id: "String", # required
  request_validator_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.validate_request_body #=> true/false
resp.validate_request_parameters #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    [Required] The identifier of the RequestValidator to be retrieved.

Returns:

#get_request_validators(options = {}) ⇒ Types::RequestValidators

Gets the RequestValidators collection of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.get_request_validators({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].validate_request_body #=> true/false
resp.items[0].validate_request_parameters #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_resource(options = {}) ⇒ Types::Resource

Lists information about a resource.

Examples:

Request syntax with placeholder values


resp = client.get_resource({
  rest_api_id: "String", # required
  resource_id: "String", # required
  embed: ["String"],
})

Response structure


resp.id #=> String
resp.parent_id #=> String
resp.path_part #=> String
resp.path #=> String
resp.resource_methods #=> Hash
resp.resource_methods["String"].http_method #=> String
resp.resource_methods["String"].authorization_type #=> String
resp.resource_methods["String"].authorizer_id #=> String
resp.resource_methods["String"].api_key_required #=> true/false
resp.resource_methods["String"].request_validator_id #=> String
resp.resource_methods["String"].operation_name #=> String
resp.resource_methods["String"].request_parameters #=> Hash
resp.resource_methods["String"].request_parameters["String"] #=> true/false
resp.resource_methods["String"].request_models #=> Hash
resp.resource_methods["String"].request_models["String"] #=> String
resp.resource_methods["String"].method_responses #=> Hash
resp.resource_methods["String"].method_responses["String"].status_code #=> String
resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> true/false
resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.resource_methods["String"].method_integration.http_method #=> String
resp.resource_methods["String"].method_integration.uri #=> String
resp.resource_methods["String"].method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.resource_methods["String"].method_integration.connection_id #=> String
resp.resource_methods["String"].method_integration.credentials #=> String
resp.resource_methods["String"].method_integration.request_parameters #=> Hash
resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.request_templates #=> Hash
resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.timeout_in_millis #=> Integer
resp.resource_methods["String"].method_integration.cache_namespace #=> String
resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.resource_methods["String"].method_integration.integration_responses #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.tls_config.insecure_skip_verification #=> true/false
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The identifier for the Resource resource.

  • :embed (Array<String>) —

    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.

Returns:

#get_resources(options = {}) ⇒ Types::Resources

Lists information about a collection of Resource resources.

Examples:

Request syntax with placeholder values


resp = client.get_resources({
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
  embed: ["String"],
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].parent_id #=> String
resp.items[0].path_part #=> String
resp.items[0].path #=> String
resp.items[0].resource_methods #=> Hash
resp.items[0].resource_methods["String"].http_method #=> String
resp.items[0].resource_methods["String"].authorization_type #=> String
resp.items[0].resource_methods["String"].authorizer_id #=> String
resp.items[0].resource_methods["String"].api_key_required #=> true/false
resp.items[0].resource_methods["String"].request_validator_id #=> String
resp.items[0].resource_methods["String"].operation_name #=> String
resp.items[0].resource_methods["String"].request_parameters #=> Hash
resp.items[0].resource_methods["String"].request_parameters["String"] #=> true/false
resp.items[0].resource_methods["String"].request_models #=> Hash
resp.items[0].resource_methods["String"].request_models["String"] #=> String
resp.items[0].resource_methods["String"].method_responses #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].status_code #=> String
resp.items[0].resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].response_parameters["String"] #=> true/false
resp.items[0].resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.items[0].resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.items[0].resource_methods["String"].method_integration.http_method #=> String
resp.items[0].resource_methods["String"].method_integration.uri #=> String
resp.items[0].resource_methods["String"].method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.items[0].resource_methods["String"].method_integration.connection_id #=> String
resp.items[0].resource_methods["String"].method_integration.credentials #=> String
resp.items[0].resource_methods["String"].method_integration.request_parameters #=> Hash
resp.items[0].resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.request_templates #=> Hash
resp.items[0].resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.items[0].resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.items[0].resource_methods["String"].method_integration.timeout_in_millis #=> Integer
resp.items[0].resource_methods["String"].method_integration.cache_namespace #=> String
resp.items[0].resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.items[0].resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.items[0].resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.items[0].resource_methods["String"].method_integration.tls_config.insecure_skip_verification #=> true/false
resp.items[0].resource_methods["String"].authorization_scopes #=> Array
resp.items[0].resource_methods["String"].authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

  • :embed (Array<String>) —

    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.

Returns:

#get_rest_api(options = {}) ⇒ Types::RestApi

Lists the RestApi resource in the collection.

Examples:

Request syntax with placeholder values


resp = client.get_rest_api({
  rest_api_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

Returns:

#get_rest_apis(options = {}) ⇒ Types::RestApis

Lists the RestApis resources for your collection.

Examples:

Request syntax with placeholder values


resp = client.get_rest_apis({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].created_date #=> Time
resp.items[0].version #=> String
resp.items[0].warnings #=> Array
resp.items[0].warnings[0] #=> String
resp.items[0].binary_media_types #=> Array
resp.items[0].binary_media_types[0] #=> String
resp.items[0].minimum_compression_size #=> Integer
resp.items[0].api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.items[0].endpoint_configuration.types #=> Array
resp.items[0].endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.items[0].endpoint_configuration.vpc_endpoint_ids #=> Array
resp.items[0].endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.items[0].policy #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String
resp.items[0].disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_sdk(options = {}) ⇒ Types::SdkResponse

Generates a client SDK for a RestApi and Stage.

Examples:

Request syntax with placeholder values


resp = client.get_sdk({
  rest_api_id: "String", # required
  stage_name: "String", # required
  sdk_type: "String", # required
  parameters: {
    "String" => "String",
  },
})

Response structure


resp.content_type #=> String
resp.content_disposition #=> String
resp.body #=> IO

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name of the Stage that the SDK will use.

  • :sdk_type (required, String) —

    [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

  • :parameters (Hash<String,String>) —

    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.

Returns:

#get_sdk_type(options = {}) ⇒ Types::SdkType

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_sdk_type({
  id: "String", # required
})

Response structure


resp.id #=> String
resp.friendly_name #=> String
resp.description #=> String
resp.configuration_properties #=> Array
resp.configuration_properties[0].name #=> String
resp.configuration_properties[0].friendly_name #=> String
resp.configuration_properties[0].description #=> String
resp.configuration_properties[0].required #=> true/false
resp.configuration_properties[0].default_value #=> String

Options Hash (options):

  • :id (required, String) —

    [Required] The identifier of the queried SdkType instance.

Returns:

#get_sdk_types(options = {}) ⇒ Types::SdkTypes

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.get_sdk_types({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].friendly_name #=> String
resp.items[0].description #=> String
resp.items[0].configuration_properties #=> Array
resp.items[0].configuration_properties[0].name #=> String
resp.items[0].configuration_properties[0].friendly_name #=> String
resp.items[0].configuration_properties[0].description #=> String
resp.items[0].configuration_properties[0].required #=> true/false
resp.items[0].configuration_properties[0].default_value #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_stage(options = {}) ⇒ Types::Stage

Gets information about a Stage resource.

Examples:

Request syntax with placeholder values


resp = client.get_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
})

Response structure


resp.deployment_id #=> String
resp.client_certificate_id #=> String
resp.stage_name #=> String
resp.description #=> String
resp.cache_cluster_enabled #=> true/false
resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.method_settings #=> Hash
resp.method_settings["String"].metrics_enabled #=> true/false
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> true/false
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> true/false
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> true/false
resp.method_settings["String"].require_authorization_for_cache_control #=> true/false
resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.variables #=> Hash
resp.variables["String"] #=> String
resp.documentation_version #=> String
resp.access_log_settings.format #=> String
resp.access_log_settings.destination_arn #=> String
resp.canary_settings.percent_traffic #=> Float
resp.canary_settings.deployment_id #=> String
resp.canary_settings.stage_variable_overrides #=> Hash
resp.canary_settings.stage_variable_overrides["String"] #=> String
resp.canary_settings.use_stage_cache #=> true/false
resp.tracing_enabled #=> true/false
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    [Required] The name of the Stage resource to get information about.

Returns:

#get_stages(options = {}) ⇒ Types::Stages

Gets information about one or more Stage resources.

Examples:

Request syntax with placeholder values


resp = client.get_stages({
  rest_api_id: "String", # required
  deployment_id: "String",
})

Response structure


resp.item #=> Array
resp.item[0].deployment_id #=> String
resp.item[0].client_certificate_id #=> String
resp.item[0].stage_name #=> String
resp.item[0].description #=> String
resp.item[0].cache_cluster_enabled #=> true/false
resp.item[0].cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.item[0].cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.item[0].method_settings #=> Hash
resp.item[0].method_settings["String"].metrics_enabled #=> true/false
resp.item[0].method_settings["String"].logging_level #=> String
resp.item[0].method_settings["String"].data_trace_enabled #=> true/false
resp.item[0].method_settings["String"].throttling_burst_limit #=> Integer
resp.item[0].method_settings["String"].throttling_rate_limit #=> Float
resp.item[0].method_settings["String"].caching_enabled #=> true/false
resp.item[0].method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.item[0].method_settings["String"].cache_data_encrypted #=> true/false
resp.item[0].method_settings["String"].require_authorization_for_cache_control #=> true/false
resp.item[0].method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.item[0].variables #=> Hash
resp.item[0].variables["String"] #=> String
resp.item[0].documentation_version #=> String
resp.item[0].access_log_settings.format #=> String
resp.item[0].access_log_settings.destination_arn #=> String
resp.item[0].canary_settings.percent_traffic #=> Float
resp.item[0].canary_settings.deployment_id #=> String
resp.item[0].canary_settings.stage_variable_overrides #=> Hash
resp.item[0].canary_settings.stage_variable_overrides["String"] #=> String
resp.item[0].canary_settings.use_stage_cache #=> true/false
resp.item[0].tracing_enabled #=> true/false
resp.item[0].web_acl_arn #=> String
resp.item[0].tags #=> Hash
resp.item[0].tags["String"] #=> String
resp.item[0].created_date #=> Time
resp.item[0].last_updated_date #=> Time

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (String) —

    The stages\' deployment identifiers.

Returns:

#get_tags(options = {}) ⇒ Types::Tags

Gets the Tags collection for a given resource.

Examples:

Request syntax with placeholder values


resp = client.get_tags({
  resource_arn: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :resource_arn (required, String) —

    [Required] The ARN of a resource that can be tagged.

  • :position (String) — default: Not currently supported —

    The current pagination position in the paged result set.

  • :limit (Integer) — default: Not currently supported —

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

Returns:

#get_usage(options = {}) ⇒ Types::Usage

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

Examples:

Request syntax with placeholder values


resp = client.get_usage({
  usage_plan_id: "String", # required
  key_id: "String",
  start_date: "String", # required
  end_date: "String", # required
  position: "String",
  limit: 1,
})

Response structure


resp.usage_plan_id #=> String
resp.start_date #=> String
resp.end_date #=> String
resp.position #=> String
resp.items #=> Hash
resp.items["String"] #=> Array
resp.items["String"][0] #=> Array
resp.items["String"][0][0] #=> Integer

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :key_id (String) —

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

  • :start_date (required, String) —

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

  • :end_date (required, String) —

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

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#get_usage_plan(options = {}) ⇒ Types::UsagePlan

Gets a usage plan of a given plan identifier.

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan({
  usage_plan_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.api_stages #=> Array
resp.api_stages[0].api_id #=> String
resp.api_stages[0].stage #=> String
resp.api_stages[0].throttle #=> Hash
resp.api_stages[0].throttle["String"].burst_limit #=> Integer
resp.api_stages[0].throttle["String"].rate_limit #=> Float
resp.throttle.burst_limit #=> Integer
resp.throttle.rate_limit #=> Float
resp.quota.limit #=> Integer
resp.quota.offset #=> Integer
resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.product_code #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :usage_plan_id (required, String) —

    [Required] The identifier of the UsagePlan resource to be retrieved.

Returns:

#get_usage_plan_key(options = {}) ⇒ Types::UsagePlanKey

Gets a usage plan key of a given key identifier.

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan_key({
  usage_plan_id: "String", # required
  key_id: "String", # required
})

Response structure


resp.id #=> String
resp.type #=> String
resp.value #=> String
resp.name #=> String

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :key_id (required, String) —

    [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:

#get_usage_plan_keys(options = {}) ⇒ Types::UsagePlanKeys

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

Examples:

Request syntax with placeholder values


resp = client.get_usage_plan_keys({
  usage_plan_id: "String", # required
  position: "String",
  limit: 1,
  name_query: "String",
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].type #=> String
resp.items[0].value #=> String
resp.items[0].name #=> String

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

  • :name_query (String) —

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

Returns:

#get_usage_plans(options = {}) ⇒ Types::UsagePlans

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

Examples:

Request syntax with placeholder values


resp = client.get_usage_plans({
  position: "String",
  key_id: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].api_stages #=> Array
resp.items[0].api_stages[0].api_id #=> String
resp.items[0].api_stages[0].stage #=> String
resp.items[0].api_stages[0].throttle #=> Hash
resp.items[0].api_stages[0].throttle["String"].burst_limit #=> Integer
resp.items[0].api_stages[0].throttle["String"].rate_limit #=> Float
resp.items[0].throttle.burst_limit #=> Integer
resp.items[0].throttle.rate_limit #=> Float
resp.items[0].quota.limit #=> Integer
resp.items[0].quota.offset #=> Integer
resp.items[0].quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.items[0].product_code #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :key_id (String) —

    The identifier of the API key associated with the usage plans.

  • :limit (Integer) —

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

Returns:

#get_vpc_link(options = {}) ⇒ Types::VpcLink

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

Examples:

Request syntax with placeholder values


resp = client.get_vpc_link({
  vpc_link_id: "String", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.target_arns #=> Array
resp.target_arns[0] #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.status_message #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :vpc_link_id (required, String) —

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

Returns:

#get_vpc_links(options = {}) ⇒ Types::VpcLinks

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

Examples:

Request syntax with placeholder values


resp = client.get_vpc_links({
  position: "String",
  limit: 1,
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].target_arns #=> Array
resp.items[0].target_arns[0] #=> String
resp.items[0].status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.items[0].status_message #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String

Options Hash (options):

  • :position (String) —

    The current pagination position in the paged result set.

  • :limit (Integer) —

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

Returns:

#import_api_keys(options = {}) ⇒ Types::ApiKeyIds

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

Examples:

Request syntax with placeholder values


resp = client.import_api_keys({
  body: "data", # required
  format: "csv", # required, accepts csv
  fail_on_warnings: false,
})

Response structure


resp.ids #=> Array
resp.ids[0] #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Options Hash (options):

  • :body (required, IO, String) —

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

  • :format (required, String) —

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

  • :fail_on_warnings (Boolean) —

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

Returns:

#import_documentation_parts(options = {}) ⇒ Types::DocumentationPartIds

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.import_documentation_parts({
  rest_api_id: "String", # required
  mode: "merge", # accepts merge, overwrite
  fail_on_warnings: false,
  body: "data", # required
})

Response structure


resp.ids #=> Array
resp.ids[0] #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :mode (String) —

    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.

  • :fail_on_warnings (Boolean) —

    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.

  • :body (required, IO, String) —

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

Returns:

#import_rest_api(options = {}) ⇒ Types::RestApi

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

Examples:

Request syntax with placeholder values


resp = client.import_rest_api({
  fail_on_warnings: false,
  parameters: {
    "String" => "String",
  },
  body: "data", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :fail_on_warnings (Boolean) —

    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 (Hash<String,String>) —

    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'
  • :body (required, IO, String) —

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

Returns:

#put_gateway_response(options = {}) ⇒ Types::GatewayResponse

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

Examples:

Request syntax with placeholder values


resp = client.put_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
  status_code: "StatusCode",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String) —

    [Required] The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE

  • :status_code (String) —

    The HTTP status code of the GatewayResponse.

  • :response_parameters (Hash<String,String>) —

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

  • :response_templates (Hash<String,String>) —

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

Returns:

#put_integration(options = {}) ⇒ Types::Integration

Sets up a method's integration.

Examples:

Request syntax with placeholder values


resp = client.put_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  type: "HTTP", # required, accepts HTTP, AWS, MOCK, HTTP_PROXY, AWS_PROXY
  integration_http_method: "String",
  uri: "String",
  connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
  connection_id: "String",
  credentials: "String",
  request_parameters: {
    "String" => "String",
  },
  request_templates: {
    "String" => "String",
  },
  passthrough_behavior: "String",
  cache_namespace: "String",
  cache_key_parameters: ["String"],
  content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  timeout_in_millis: 1,
  tls_config: {
    insecure_skip_verification: false,
  },
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.connection_id #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.timeout_in_millis #=> Integer
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].response_parameters #=> Hash
resp.integration_responses["String"].response_parameters["String"] #=> String
resp.integration_responses["String"].response_templates #=> Hash
resp.integration_responses["String"].response_templates["String"] #=> String
resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.tls_config.insecure_skip_verification #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] Specifies a put integration request\'s resource ID.

  • :http_method (required, String) —

    [Required] Specifies a put integration request\'s HTTP method.

  • :type (required, String) —

    [Required] Specifies a put integration input\'s type.

  • :integration_http_method (String) —

    Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

  • :uri (String) —

    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 specificationtarget="_blank", 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}`

  • :connection_type (String) —

    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.

  • :connection_id (String) —

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

  • :credentials (String) —

    Specifies whether credentials are required for a put integration.

  • :request_parameters (Hash<String,String>) —

    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.

  • :request_templates (Hash<String,String>) —

    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.

  • :passthrough_behavior (String) —

    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.

  • :cache_namespace (String) —

    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.

  • :cache_key_parameters (Array<String>) —

    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.

  • :content_handling (String) —

    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.

  • :timeout_in_millis (Integer) —

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

  • :tls_config (Types::TlsConfig)

Returns:

#put_integration_response(options = {}) ⇒ Types::IntegrationResponse

Represents a put integration.

Examples:

Request syntax with placeholder values


resp = client.put_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  selection_pattern: "String",
  response_parameters: {
    "String" => "String",
  },
  response_templates: {
    "String" => "String",
  },
  content_handling: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
})

Response structure


resp.status_code #=> String
resp.selection_pattern #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

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

  • :http_method (required, String) —

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

  • :status_code (required, String) —

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

  • :selection_pattern (String) —

    Specifies the selection pattern of a put integration response.

  • :response_parameters (Hash<String,String>) —

    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.

  • :response_templates (Hash<String,String>) —

    Specifies a put integration response\'s templates.

  • :content_handling (String) —

    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.

Returns:

#put_method(options = {}) ⇒ Types::Method

Add a method to an existing Resource resource.

Examples:

Request syntax with placeholder values


resp = client.put_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  authorization_type: "String", # required
  authorizer_id: "String",
  api_key_required: false,
  operation_name: "String",
  request_parameters: {
    "String" => false,
  },
  request_models: {
    "String" => "String",
  },
  request_validator_id: "String",
  authorization_scopes: ["String"],
})

Response structure


resp.http_method #=> String
resp.authorization_type #=> String
resp.authorizer_id #=> String
resp.api_key_required #=> true/false
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> true/false
resp.request_models #=> Hash
resp.request_models["String"] #=> String
resp.method_responses #=> Hash
resp.method_responses["String"].status_code #=> String
resp.method_responses["String"].response_parameters #=> Hash
resp.method_responses["String"].response_parameters["String"] #=> true/false
resp.method_responses["String"].response_models #=> Hash
resp.method_responses["String"].response_models["String"] #=> String
resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.method_integration.http_method #=> String
resp.method_integration.uri #=> String
resp.method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.method_integration.connection_id #=> String
resp.method_integration.credentials #=> String
resp.method_integration.request_parameters #=> Hash
resp.method_integration.request_parameters["String"] #=> String
resp.method_integration.request_templates #=> Hash
resp.method_integration.request_templates["String"] #=> String
resp.method_integration.passthrough_behavior #=> String
resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.timeout_in_millis #=> Integer
resp.method_integration.cache_namespace #=> String
resp.method_integration.cache_key_parameters #=> Array
resp.method_integration.cache_key_parameters[0] #=> String
resp.method_integration.integration_responses #=> Hash
resp.method_integration.integration_responses["String"].status_code #=> String
resp.method_integration.integration_responses["String"].selection_pattern #=> String
resp.method_integration.integration_responses["String"].response_parameters #=> Hash
resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.method_integration.integration_responses["String"].response_templates #=> Hash
resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.tls_config.insecure_skip_verification #=> true/false
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the new Method resource.

  • :http_method (required, String) —

    [Required] Specifies the method request\'s HTTP method type.

  • :authorization_type (required, String) —

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

  • :authorizer_id (String) —

    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.

  • :api_key_required (Boolean) —

    Specifies whether the method required a valid ApiKey.

  • :operation_name (String) —

    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.

  • :request_parameters (Hash<String,Boolean>) —

    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.

  • :request_models (Hash<String,String>) —

    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.

  • :request_validator_id (String) —

    The identifier of a RequestValidator for validating the method request.

  • :authorization_scopes (Array<String>) —

    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.

Returns:

#put_method_response(options = {}) ⇒ Types::MethodResponse

Adds a MethodResponse to an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.put_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  response_parameters: {
    "String" => false,
  },
  response_models: {
    "String" => "String",
  },
})

Response structure


resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> true/false
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String) —

    [Required] The method response\'s status code.

  • :response_parameters (Hash<String,Boolean>) —

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

  • :response_models (Hash<String,String>) —

    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.

Returns:

#put_rest_api(options = {}) ⇒ Types::RestApi

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.

Examples:

Request syntax with placeholder values


resp = client.put_rest_api({
  rest_api_id: "String", # required
  mode: "merge", # accepts merge, overwrite
  fail_on_warnings: false,
  parameters: {
    "String" => "String",
  },
  body: "data", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :mode (String) —

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

  • :fail_on_warnings (Boolean) —

    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.

  • :parameters (Hash<String,String>) —

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

  • :body (required, IO, String) —

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

Returns:

#tag_resource(options = {}) ⇒ Struct

Adds or updates a tag on a given resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Options Hash (options):

  • :resource_arn (required, String) —

    [Required] The ARN of a resource that can be tagged.

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

#test_invoke_authorizer(options = {}) ⇒ Types::TestInvokeAuthorizerResponse

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

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

Examples:

Request syntax with placeholder values


resp = client.test_invoke_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
  headers: {
    "String" => "String",
  },
  multi_value_headers: {
    "String" => ["String"],
  },
  path_with_query_string: "String",
  body: "String",
  stage_variables: {
    "String" => "String",
  },
  additional_context: {
    "String" => "String",
  },
})

Response structure


resp.client_status #=> Integer
resp.log #=> String
resp.latency #=> Integer
resp.principal_id #=> String
resp.policy #=> String
resp.authorization #=> Hash
resp.authorization["String"] #=> Array
resp.authorization["String"][0] #=> String
resp.claims #=> Hash
resp.claims["String"] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    [Required] Specifies a test invoke authorizer request\'s Authorizer ID.

  • :headers (Hash<String,String>) —

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

  • :multi_value_headers (Hash<String,Array<String>>) —

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

  • :path_with_query_string (String) —

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

  • :body (String) —

    [Optional] The simulated request body of an incoming invocation request.

  • :stage_variables (Hash<String,String>) —

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

  • :additional_context (Hash<String,String>) —

    [Optional] A key-value map of additional context variables.

Returns:

#test_invoke_method(options = {}) ⇒ Types::TestInvokeMethodResponse

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

Examples:

Request syntax with placeholder values


resp = client.test_invoke_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  path_with_query_string: "String",
  body: "String",
  headers: {
    "String" => "String",
  },
  multi_value_headers: {
    "String" => ["String"],
  },
  client_certificate_id: "String",
  stage_variables: {
    "String" => "String",
  },
})

Response structure


resp.status #=> Integer
resp.body #=> String
resp.headers #=> Hash
resp.headers["String"] #=> String
resp.multi_value_headers #=> Hash
resp.multi_value_headers["String"] #=> Array
resp.multi_value_headers["String"][0] #=> String
resp.log #=> String
resp.latency #=> Integer

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

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

  • :http_method (required, String) —

    [Required] Specifies a test invoke method request\'s HTTP method.

  • :path_with_query_string (String) —

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

  • :body (String) —

    The simulated request body of an incoming invocation request.

  • :headers (Hash<String,String>) —

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

  • :multi_value_headers (Hash<String,Array<String>>) —

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

  • :client_certificate_id (String) —

    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.

  • :stage_variables (Hash<String,String>) —

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

Returns:

#untag_resource(options = {}) ⇒ Struct

Removes a tag from a given resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_arn (required, String) —

    [Required] The ARN of a resource that can be tagged.

  • :tag_keys (required, Array<String>) —

    [Required] The Tag keys to delete.

Returns:

  • (Struct) —

    Returns an empty response.

#update_account(options = {}) ⇒ Types::Account

Changes information about the current Account resource.

Examples:

Request syntax with placeholder values


resp = client.({
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.cloudwatch_role_arn #=> String
resp.throttle_settings.burst_limit #=> Integer
resp.throttle_settings.rate_limit #=> Float
resp.features #=> Array
resp.features[0] #=> String
resp.api_key_version #=> String

Options Hash (options):

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_api_key(options = {}) ⇒ Types::ApiKey

Changes information about an ApiKey resource.

Examples:

Request syntax with placeholder values


resp = client.update_api_key({
  api_key: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.value #=> String
resp.name #=> String
resp.customer_id #=> String
resp.description #=> String
resp.enabled #=> true/false
resp.created_date #=> Time
resp.last_updated_date #=> Time
resp.stage_keys #=> Array
resp.stage_keys[0] #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :api_key (required, String) —

    [Required] The identifier of the ApiKey resource to be updated.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_authorizer(options = {}) ⇒ Types::Authorizer

Updates an existing Authorizer resource.

AWS CLI

Examples:

Request syntax with placeholder values


resp = client.update_authorizer({
  rest_api_id: "String", # required
  authorizer_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type #=> String, one of "TOKEN", "REQUEST", "COGNITO_USER_POOLS"
resp.provider_arns #=> Array
resp.provider_arns[0] #=> String
resp.auth_type #=> String
resp.authorizer_uri #=> String
resp.authorizer_credentials #=> String
resp.identity_source #=> String
resp.identity_validation_expression #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    [Required] The identifier of the Authorizer resource.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_base_path_mapping(options = {}) ⇒ Types::BasePathMapping

Changes information about the BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.update_base_path_mapping({
  domain_name: "String", # required
  base_path: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.base_path #=> String
resp.rest_api_id #=> String
resp.stage #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The domain name of the BasePathMapping resource to change.

  • :base_path (required, String) —

    [Required] The base path of the BasePathMapping resource to change.

    To specify an empty base path, set this parameter to '(none)'.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_client_certificate(options = {}) ⇒ Types::ClientCertificate

Changes information about an ClientCertificate resource.

Examples:

Request syntax with placeholder values


resp = client.update_client_certificate({
  client_certificate_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.client_certificate_id #=> String
resp.description #=> String
resp.pem_encoded_certificate #=> String
resp.created_date #=> Time
resp.expiration_date #=> Time
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :client_certificate_id (required, String) —

    [Required] The identifier of the ClientCertificate resource to be updated.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_deployment(options = {}) ⇒ Types::Deployment

Changes information about a Deployment resource.

Examples:

Request syntax with placeholder values


resp = client.update_deployment({
  rest_api_id: "String", # required
  deployment_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.description #=> String
resp.created_date #=> Time
resp.api_summary #=> Hash
resp.api_summary["String"] #=> Hash
resp.api_summary["String"]["String"].authorization_type #=> String
resp.api_summary["String"]["String"].api_key_required #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :deployment_id (required, String) —

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

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_documentation_part(options = {}) ⇒ Types::DocumentationPart

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.update_documentation_part({
  rest_api_id: "String", # required
  documentation_part_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.location.type #=> String, one of "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY"
resp.location.path #=> String
resp.location.method #=> String
resp.location.status_code #=> String
resp.location.name #=> String
resp.properties #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

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

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_documentation_version(options = {}) ⇒ Types::DocumentationVersion

Returns a response object which responds to the following methods:

Examples:

Request syntax with placeholder values


resp = client.update_documentation_version({
  rest_api_id: "String", # required
  documentation_version: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.version #=> String
resp.created_date #=> Time
resp.description #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi..

  • :documentation_version (required, String) —

    [Required] The version identifier of the to-be-updated documentation version.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_domain_name(options = {}) ⇒ Types::DomainName

Changes information about the DomainName resource.

Examples:

Request syntax with placeholder values


resp = client.update_domain_name({
  domain_name: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.domain_name #=> String
resp.certificate_name #=> String
resp.certificate_arn #=> String
resp.certificate_upload_date #=> Time
resp.regional_domain_name #=> String
resp.regional_hosted_zone_id #=> String
resp.regional_certificate_name #=> String
resp.regional_certificate_arn #=> String
resp.distribution_domain_name #=> String
resp.distribution_hosted_zone_id #=> String
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String

Options Hash (options):

  • :domain_name (required, String) —

    [Required] The name of the DomainName resource to be changed.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_gateway_response(options = {}) ⇒ Types::GatewayResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_gateway_response({
  rest_api_id: "String", # required
  response_type: "DEFAULT_4XX", # required, accepts DEFAULT_4XX, DEFAULT_5XX, RESOURCE_NOT_FOUND, UNAUTHORIZED, INVALID_API_KEY, ACCESS_DENIED, AUTHORIZER_FAILURE, AUTHORIZER_CONFIGURATION_ERROR, INVALID_SIGNATURE, EXPIRED_TOKEN, MISSING_AUTHENTICATION_TOKEN, INTEGRATION_FAILURE, INTEGRATION_TIMEOUT, API_CONFIGURATION_ERROR, UNSUPPORTED_MEDIA_TYPE, BAD_REQUEST_PARAMETERS, BAD_REQUEST_BODY, REQUEST_TOO_LARGE, THROTTLED, QUOTA_EXCEEDED
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.response_type #=> String, one of "DEFAULT_4XX", "DEFAULT_5XX", "RESOURCE_NOT_FOUND", "UNAUTHORIZED", "INVALID_API_KEY", "ACCESS_DENIED", "AUTHORIZER_FAILURE", "AUTHORIZER_CONFIGURATION_ERROR", "INVALID_SIGNATURE", "EXPIRED_TOKEN", "MISSING_AUTHENTICATION_TOKEN", "INTEGRATION_FAILURE", "INTEGRATION_TIMEOUT", "API_CONFIGURATION_ERROR", "UNSUPPORTED_MEDIA_TYPE", "BAD_REQUEST_PARAMETERS", "BAD_REQUEST_BODY", "REQUEST_TOO_LARGE", "THROTTLED", "QUOTA_EXCEEDED"
resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.default_response #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :response_type (required, String) —

    [Required] The response type of the associated GatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_integration(options = {}) ⇒ Types::Integration

Represents an update integration.

Examples:

Request syntax with placeholder values


resp = client.update_integration({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.http_method #=> String
resp.uri #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.connection_id #=> String
resp.credentials #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> String
resp.request_templates #=> Hash
resp.request_templates["String"] #=> String
resp.passthrough_behavior #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.timeout_in_millis #=> Integer
resp.cache_namespace #=> String
resp.cache_key_parameters #=> Array
resp.cache_key_parameters[0] #=> String
resp.integration_responses #=> Hash
resp.integration_responses["String"].status_code #=> String
resp.integration_responses["String"].selection_pattern #=> String
resp.integration_responses["String"].response_parameters #=> Hash
resp.integration_responses["String"].response_parameters["String"] #=> String
resp.integration_responses["String"].response_templates #=> Hash
resp.integration_responses["String"].response_templates["String"] #=> String
resp.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.tls_config.insecure_skip_verification #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] Represents an update integration request\'s resource identifier.

  • :http_method (required, String) —

    [Required] Represents an update integration request\'s HTTP method.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_integration_response(options = {}) ⇒ Types::IntegrationResponse

Represents an update integration response.

Examples:

Request syntax with placeholder values


resp = client.update_integration_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.status_code #=> String
resp.selection_pattern #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> String
resp.response_templates #=> Hash
resp.response_templates["String"] #=> String
resp.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

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

  • :http_method (required, String) —

    [Required] Specifies an update integration response request\'s HTTP method.

  • :status_code (required, String) —

    [Required] Specifies an update integration response request\'s status code.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_method(options = {}) ⇒ Types::Method

Updates an existing Method resource.

Examples:

Request syntax with placeholder values


resp = client.update_method({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.http_method #=> String
resp.authorization_type #=> String
resp.authorizer_id #=> String
resp.api_key_required #=> true/false
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> true/false
resp.request_models #=> Hash
resp.request_models["String"] #=> String
resp.method_responses #=> Hash
resp.method_responses["String"].status_code #=> String
resp.method_responses["String"].response_parameters #=> Hash
resp.method_responses["String"].response_parameters["String"] #=> true/false
resp.method_responses["String"].response_models #=> Hash
resp.method_responses["String"].response_models["String"] #=> String
resp.method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.method_integration.http_method #=> String
resp.method_integration.uri #=> String
resp.method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.method_integration.connection_id #=> String
resp.method_integration.credentials #=> String
resp.method_integration.request_parameters #=> Hash
resp.method_integration.request_parameters["String"] #=> String
resp.method_integration.request_templates #=> Hash
resp.method_integration.request_templates["String"] #=> String
resp.method_integration.passthrough_behavior #=> String
resp.method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.timeout_in_millis #=> Integer
resp.method_integration.cache_namespace #=> String
resp.method_integration.cache_key_parameters #=> Array
resp.method_integration.cache_key_parameters[0] #=> String
resp.method_integration.integration_responses #=> Hash
resp.method_integration.integration_responses["String"].status_code #=> String
resp.method_integration.integration_responses["String"].selection_pattern #=> String
resp.method_integration.integration_responses["String"].response_parameters #=> Hash
resp.method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.method_integration.integration_responses["String"].response_templates #=> Hash
resp.method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.method_integration.tls_config.insecure_skip_verification #=> true/false
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the Method resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_method_response(options = {}) ⇒ Types::MethodResponse

Updates an existing MethodResponse resource.

Examples:

Request syntax with placeholder values


resp = client.update_method_response({
  rest_api_id: "String", # required
  resource_id: "String", # required
  http_method: "String", # required
  status_code: "StatusCode", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.status_code #=> String
resp.response_parameters #=> Hash
resp.response_parameters["String"] #=> true/false
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    [Required] The HTTP verb of the Method resource.

  • :status_code (required, String) —

    [Required] The status code for the MethodResponse resource.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_model(options = {}) ⇒ Types::Model

Changes information about a model.

Examples:

Request syntax with placeholder values


resp = client.update_model({
  rest_api_id: "String", # required
  model_name: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.schema #=> String
resp.content_type #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :model_name (required, String) —

    [Required] The name of the model to update.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_request_validator(options = {}) ⇒ Types::RequestValidator

Updates a RequestValidator of a given RestApi.

Examples:

Request syntax with placeholder values


resp = client.update_request_validator({
  rest_api_id: "String", # required
  request_validator_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.validate_request_body #=> true/false
resp.validate_request_parameters #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    [Required] The identifier of RequestValidator to be updated.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_resource(options = {}) ⇒ Types::Resource

Changes information about a Resource resource.

Examples:

Request syntax with placeholder values


resp = client.update_resource({
  rest_api_id: "String", # required
  resource_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.parent_id #=> String
resp.path_part #=> String
resp.path #=> String
resp.resource_methods #=> Hash
resp.resource_methods["String"].http_method #=> String
resp.resource_methods["String"].authorization_type #=> String
resp.resource_methods["String"].authorizer_id #=> String
resp.resource_methods["String"].api_key_required #=> true/false
resp.resource_methods["String"].request_validator_id #=> String
resp.resource_methods["String"].operation_name #=> String
resp.resource_methods["String"].request_parameters #=> Hash
resp.resource_methods["String"].request_parameters["String"] #=> true/false
resp.resource_methods["String"].request_models #=> Hash
resp.resource_methods["String"].request_models["String"] #=> String
resp.resource_methods["String"].method_responses #=> Hash
resp.resource_methods["String"].method_responses["String"].status_code #=> String
resp.resource_methods["String"].method_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_responses["String"].response_parameters["String"] #=> true/false
resp.resource_methods["String"].method_responses["String"].response_models #=> Hash
resp.resource_methods["String"].method_responses["String"].response_models["String"] #=> String
resp.resource_methods["String"].method_integration.type #=> String, one of "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.resource_methods["String"].method_integration.http_method #=> String
resp.resource_methods["String"].method_integration.uri #=> String
resp.resource_methods["String"].method_integration.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.resource_methods["String"].method_integration.connection_id #=> String
resp.resource_methods["String"].method_integration.credentials #=> String
resp.resource_methods["String"].method_integration.request_parameters #=> Hash
resp.resource_methods["String"].method_integration.request_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.request_templates #=> Hash
resp.resource_methods["String"].method_integration.request_templates["String"] #=> String
resp.resource_methods["String"].method_integration.passthrough_behavior #=> String
resp.resource_methods["String"].method_integration.content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.timeout_in_millis #=> Integer
resp.resource_methods["String"].method_integration.cache_namespace #=> String
resp.resource_methods["String"].method_integration.cache_key_parameters #=> Array
resp.resource_methods["String"].method_integration.cache_key_parameters[0] #=> String
resp.resource_methods["String"].method_integration.integration_responses #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].status_code #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].selection_pattern #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_parameters["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates #=> Hash
resp.resource_methods["String"].method_integration.integration_responses["String"].response_templates["String"] #=> String
resp.resource_methods["String"].method_integration.integration_responses["String"].content_handling #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.resource_methods["String"].method_integration.tls_config.insecure_skip_verification #=> true/false
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    [Required] The identifier of the Resource resource.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_rest_api(options = {}) ⇒ Types::RestApi

Changes information about the specified API.

Examples:

Request syntax with placeholder values


resp = client.update_rest_api({
  rest_api_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String
resp.binary_media_types #=> Array
resp.binary_media_types[0] #=> String
resp.minimum_compression_size #=> Integer
resp.api_key_source #=> String, one of "HEADER", "AUTHORIZER"
resp.endpoint_configuration.types #=> Array
resp.endpoint_configuration.types[0] #=> String, one of "REGIONAL", "EDGE", "PRIVATE"
resp.endpoint_configuration.vpc_endpoint_ids #=> Array
resp.endpoint_configuration.vpc_endpoint_ids[0] #=> String
resp.policy #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.disable_execute_api_endpoint #=> true/false

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_stage(options = {}) ⇒ Types::Stage

Changes information about a Stage resource.

Examples:

Request syntax with placeholder values


resp = client.update_stage({
  rest_api_id: "String", # required
  stage_name: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.deployment_id #=> String
resp.client_certificate_id #=> String
resp.stage_name #=> String
resp.description #=> String
resp.cache_cluster_enabled #=> true/false
resp.cache_cluster_size #=> String, one of "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237"
resp.cache_cluster_status #=> String, one of "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS"
resp.method_settings #=> Hash
resp.method_settings["String"].metrics_enabled #=> true/false
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> true/false
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> true/false
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> true/false
resp.method_settings["String"].require_authorization_for_cache_control #=> true/false
resp.method_settings["String"].unauthorized_cache_control_header_strategy #=> String, one of "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER"
resp.variables #=> Hash
resp.variables["String"] #=> String
resp.documentation_version #=> String
resp.access_log_settings.format #=> String
resp.access_log_settings.destination_arn #=> String
resp.canary_settings.percent_traffic #=> Float
resp.canary_settings.deployment_id #=> String
resp.canary_settings.stage_variable_overrides #=> Hash
resp.canary_settings.stage_variable_overrides["String"] #=> String
resp.canary_settings.use_stage_cache #=> true/false
resp.tracing_enabled #=> true/false
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Options Hash (options):

  • :rest_api_id (required, String) —

    [Required] The string identifier of the associated RestApi.

  • :stage_name (required, String) —

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

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_usage(options = {}) ⇒ Types::Usage

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

Examples:

Request syntax with placeholder values


resp = client.update_usage({
  usage_plan_id: "String", # required
  key_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.usage_plan_id #=> String
resp.start_date #=> String
resp.end_date #=> String
resp.position #=> String
resp.items #=> Hash
resp.items["String"] #=> Array
resp.items["String"][0] #=> Array
resp.items["String"][0][0] #=> Integer

Options Hash (options):

  • :usage_plan_id (required, String) —

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

  • :key_id (required, String) —

    [Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_usage_plan(options = {}) ⇒ Types::UsagePlan

Updates a usage plan of a given plan Id.

Examples:

Request syntax with placeholder values


resp = client.update_usage_plan({
  usage_plan_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.api_stages #=> Array
resp.api_stages[0].api_id #=> String
resp.api_stages[0].stage #=> String
resp.api_stages[0].throttle #=> Hash
resp.api_stages[0].throttle["String"].burst_limit #=> Integer
resp.api_stages[0].throttle["String"].rate_limit #=> Float
resp.throttle.burst_limit #=> Integer
resp.throttle.rate_limit #=> Float
resp.quota.limit #=> Integer
resp.quota.offset #=> Integer
resp.quota.period #=> String, one of "DAY", "WEEK", "MONTH"
resp.product_code #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :usage_plan_id (required, String) —

    [Required] The Id of the to-be-updated usage plan.

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#update_vpc_link(options = {}) ⇒ Types::VpcLink

Updates an existing VpcLink of a specified identifier.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_link({
  vpc_link_id: "String", # required
  patch_operations: [
    {
      op: "add", # accepts add, remove, replace, move, copy, test
      path: "String",
      value: "String",
      from: "String",
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.target_arns #=> Array
resp.target_arns[0] #=> String
resp.status #=> String, one of "AVAILABLE", "PENDING", "DELETING", "FAILED"
resp.status_message #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Options Hash (options):

  • :vpc_link_id (required, String) —

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

  • :patch_operations (Array<Types::PatchOperation>) —

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

Returns:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {}) —

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.