Class: Aws::APIGateway::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

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

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::APIGateway::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::APIGateway::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



475
476
477
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 475

def initialize(*args)
  super
end

Instance Method Details

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

Create an ApiKey resource.

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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :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 Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services 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:



563
564
565
566
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 563

def create_api_key(params = {}, options = {})
  req = build_request(:create_api_key, params)
  req.send_request(options)
end

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

Adds a new Authorizer resource to an existing RestApi resource.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :name (required, String) —

    The name of the authorizer.

  • :type (required, String) —

    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:



693
694
695
696
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 693

def create_authorizer(params = {}, options = {})
  req = build_request(:create_authorizer, params)
  req.send_request(options)
end

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

Creates a new BasePathMapping resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain name of the BasePathMapping resource to create.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Required for private custom domain names.

  • :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) —

    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:



745
746
747
748
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 745

def create_base_path_mapping(params = {}, options = {})
  req = build_request(:create_base_path_mapping, params)
  req.send_request(options)
end

#create_deployment(params = {}) ⇒ 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

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

    The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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



831
832
833
834
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 831

def create_deployment(params = {}, options = {})
  req = build_request(:create_deployment, params)
  req.send_request(options)
end

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

Creates a documentation part.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

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

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

  • :properties (required, String) —

    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:



882
883
884
885
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 882

def create_documentation_part(params = {}, options = {})
  req = build_request(:create_documentation_part, params)
  req.send_request(options)
end

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

Creates a documentation version

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

    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:



924
925
926
927
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 924

def create_documentation_version(params = {}, options = {})
  req = build_request(:create_documentation_version, params)
  req.send_request(options)
end

#create_domain_name(params = {}) ⇒ 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
    ip_address_type: "ipv4", # accepts ipv4, dualstack
    vpc_endpoint_ids: ["String"],
  },
  tags: {
    "String" => "String",
  },
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2, SecurityPolicy_TLS13_1_3_2025_09, SecurityPolicy_TLS13_1_3_FIPS_2025_09, SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09, SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09, SecurityPolicy_TLS13_1_2_PQ_2025_09, SecurityPolicy_TLS13_1_2_2021_06, SecurityPolicy_TLS13_2025_EDGE, SecurityPolicy_TLS12_PFS_2025_EDGE, SecurityPolicy_TLS12_2018_EDGE
  endpoint_access_mode: "BASIC", # accepts BASIC, STRICT
  mutual_tls_authentication: {
    truststore_uri: "String",
    truststore_version: "String",
  },
  ownership_verification_certificate_arn: "String",
  policy: "String",
  routing_mode: "BASE_PATH_MAPPING_ONLY", # accepts BASE_PATH_MAPPING_ONLY, ROUTING_RULE_ONLY, ROUTING_RULE_THEN_BASE_PATH_MAPPING
})

Response structure


resp.domain_name #=> String
resp.domain_name_id #=> String
resp.domain_name_arn #=> 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION", "FAILED"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
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
resp.ownership_verification_certificate_arn #=> String
resp.management_policy #=> String
resp.policy #=> String
resp.routing_mode #=> String, one of "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the DomainName resource.

  • :certificate_name (String) —

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

  • :certificate_body (String) —

    [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private 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 Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. 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 Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.

  • :endpoint_configuration (Types::EndpointConfiguration) —

    The endpoint configuration of this DomainName showing the endpoint types and IP address 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.

  • :endpoint_access_mode (String) —

    The endpoint access mode of the DomainName. Only available for DomainNames that use security policies that start with SecurityPolicy_.

  • :mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

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

  • :ownership_verification_certificate_arn (String) —

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

  • :policy (String) —

    A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. Supported only for private custom domain names.

  • :routing_mode (String) —

    The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.

Returns:



1102
1103
1104
1105
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1102

def create_domain_name(params = {}, options = {})
  req = build_request(:create_domain_name, params)
  req.send_request(options)
end

#create_domain_name_access_association(params = {}) ⇒ Types::DomainNameAccessAssociation

Creates a domain name access association resource between an access association source and a private custom domain name.

Examples:

Request syntax with placeholder values


resp = client.create_domain_name_access_association({
  domain_name_arn: "String", # required
  access_association_source_type: "VPCE", # required, accepts VPCE
  access_association_source: "String", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.domain_name_access_association_arn #=> String
resp.domain_name_arn #=> String
resp.access_association_source_type #=> String, one of "VPCE"
resp.access_association_source #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name_arn (required, String) —

    The ARN of the domain name.

  • :access_association_source_type (required, String) —

    The type of the domain name access association source.

  • :access_association_source (required, String) —

    The identifier of the domain name access association source. For a VPCE, the value is the VPC endpoint ID.

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



1155
1156
1157
1158
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1155

def create_domain_name_access_association(params = {}, options = {})
  req = build_request(:create_domain_name_access_association, params)
  req.send_request(options)
end

#create_model(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The RestApi identifier under which the Model will be created.

  • :name (required, String) —

    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 4 model. The maximum size of the model is 400 KB.

  • :content_type (required, String) —

    The content-type for the model.

Returns:



1206
1207
1208
1209
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1206

def create_model(params = {}, options = {})
  req = build_request(:create_model, params)
  req.send_request(options)
end

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

Creates a RequestValidator 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 #=> Boolean
resp.validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1253

def create_request_validator(params = {}, options = {})
  req = build_request(:create_request_validator, params)
  req.send_request(options)
end

#create_resource(params = {}) ⇒ 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 #=> Boolean
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"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.resource_methods["String"].method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.resource_methods["String"].method_integration.integration_target #=> String
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :parent_id (required, String) —

    The parent resource's identifier.

  • :path_part (required, String) —

    The last path segment for this resource.

Returns:



1340
1341
1342
1343
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1340

def create_resource(params = {}, options = {})
  req = build_request(:create_resource, params)
  req.send_request(options)
end

#create_rest_api(params = {}) ⇒ 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
    ip_address_type: "ipv4", # accepts ipv4, dualstack
    vpc_endpoint_ids: ["String"],
  },
  policy: "String",
  tags: {
    "String" => "String",
  },
  disable_execute_api_endpoint: false,
  security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2, SecurityPolicy_TLS13_1_3_2025_09, SecurityPolicy_TLS13_1_3_FIPS_2025_09, SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09, SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09, SecurityPolicy_TLS13_1_2_PQ_2025_09, SecurityPolicy_TLS13_1_2_2021_06, SecurityPolicy_TLS13_2025_EDGE, SecurityPolicy_TLS12_PFS_2025_EDGE, SecurityPolicy_TLS12_2018_EDGE
  endpoint_access_mode: "BASIC", # accepts BASIC, STRICT
})

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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.root_resource_id #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    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 and IP address 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}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

  • :security_policy (String) —

    The Transport Layer Security (TLS) version + cipher suite for this RestApi.

  • :endpoint_access_mode (String) —

    The endpoint access mode of the RestApi. Only available for RestApis that use security policies that start with SecurityPolicy_.

Returns:



1480
1481
1482
1483
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1480

def create_rest_api(params = {}, options = {})
  req = build_request(:create_rest_api, params)
  req.send_request(options)
end

#create_stage(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> Boolean
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> Boolean
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> Boolean
resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
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 #=> Boolean
resp.tracing_enabled #=> Boolean
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

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

    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 capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

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



1618
1619
1620
1621
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1618

def create_stage(params = {}, options = {})
  req = build_request(:create_stage, params)
  req.send_request(options)
end

#create_usage_plan(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    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:



1710
1711
1712
1713
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1710

def create_usage_plan(params = {}, options = {})
  req = build_request(:create_usage_plan, params)
  req.send_request(options)
end

#create_usage_plan_key(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

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

    The identifier of a UsagePlanKey resource for a plan customer.

  • :key_type (required, String) —

    The type of a UsagePlanKey resource for a plan customer.

Returns:



1753
1754
1755
1756
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1753

def create_usage_plan_key(params = {}, options = {})
  req = build_request(:create_usage_plan_key, params)
  req.send_request(options)
end

#create_vpc_link(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name used to label and identify the VPC link.

  • :description (String) —

    The description of the VPC link.

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

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

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



1814
1815
1816
1817
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1814

def create_vpc_link(params = {}, options = {})
  req = build_request(:create_vpc_link, params)
  req.send_request(options)
end

#delete_api_key(params = {}) ⇒ Struct

Deletes the ApiKey resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String) —

    The identifier of the ApiKey resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



1834
1835
1836
1837
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1834

def delete_api_key(params = {}, options = {})
  req = build_request(:delete_api_key, params)
  req.send_request(options)
end

#delete_authorizer(params = {}) ⇒ Struct

Deletes an existing Authorizer resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    The identifier of the Authorizer resource.

Returns:

  • (Struct) —

    Returns an empty response.



1858
1859
1860
1861
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1858

def delete_authorizer(params = {}, options = {})
  req = build_request(:delete_authorizer, params)
  req.send_request(options)
end

#delete_base_path_mapping(params = {}) ⇒ Struct

Deletes the BasePathMapping resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain name of the BasePathMapping resource to delete.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

  • :base_path (required, String) —

    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.



1889
1890
1891
1892
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1889

def delete_base_path_mapping(params = {}, options = {})
  req = build_request(:delete_base_path_mapping, params)
  req.send_request(options)
end

#delete_client_certificate(params = {}) ⇒ Struct

Deletes the ClientCertificate resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String) —

    The identifier of the ClientCertificate resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



1909
1910
1911
1912
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1909

def delete_client_certificate(params = {}, options = {})
  req = build_request(:delete_client_certificate, params)
  req.send_request(options)
end

#delete_deployment(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :deployment_id (required, String) —

    The identifier of the Deployment resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1934
1935
1936
1937
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1934

def delete_deployment(params = {}, options = {})
  req = build_request(:delete_deployment, params)
  req.send_request(options)
end

#delete_documentation_part(params = {}) ⇒ Struct

Deletes a documentation part

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.



1958
1959
1960
1961
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1958

def delete_documentation_part(params = {}, options = {})
  req = build_request(:delete_documentation_part, params)
  req.send_request(options)
end

#delete_documentation_version(params = {}) ⇒ Struct

Deletes a documentation version.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.



1982
1983
1984
1985
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 1982

def delete_documentation_version(params = {}, options = {})
  req = build_request(:delete_documentation_version, params)
  req.send_request(options)
end

#delete_domain_name(params = {}) ⇒ Struct

Deletes the DomainName resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the DomainName resource to be deleted.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

Returns:

  • (Struct) —

    Returns an empty response.



2007
2008
2009
2010
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2007

def delete_domain_name(params = {}, options = {})
  req = build_request(:delete_domain_name, params)
  req.send_request(options)
end

#delete_domain_name_access_association(params = {}) ⇒ Struct

Deletes the DomainNameAccessAssociation resource.

Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_name_access_association({
  domain_name_access_association_arn: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name_access_association_arn (required, String) —

    The ARN of the domain name access association resource.

Returns:

  • (Struct) —

    Returns an empty response.



2032
2033
2034
2035
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2032

def delete_domain_name_access_association(params = {}, options = {})
  req = build_request(:delete_domain_name_access_association, params)
  req.send_request(options)
end

#delete_gateway_response(params = {}) ⇒ 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, WAF_FILTERED
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :response_type (required, String) —

    The response type of the associated GatewayResponse.

Returns:

  • (Struct) —

    Returns an empty response.



2057
2058
2059
2060
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2057

def delete_gateway_response(params = {}, options = {})
  req = build_request(:delete_gateway_response, params)
  req.send_request(options)
end

#delete_integration(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a delete integration request's resource identifier.

  • :http_method (required, String) —

    Specifies a delete integration request's HTTP method.

Returns:

  • (Struct) —

    Returns an empty response.



2085
2086
2087
2088
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2085

def delete_integration(params = {}, options = {})
  req = build_request(:delete_integration, params)
  req.send_request(options)
end

#delete_integration_response(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a delete integration response request's resource identifier.

  • :http_method (required, String) —

    Specifies a delete integration response request's HTTP method.

  • :status_code (required, String) —

    Specifies a delete integration response request's status code.

Returns:

  • (Struct) —

    Returns an empty response.



2118
2119
2120
2121
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2118

def delete_integration_response(params = {}, options = {})
  req = build_request(:delete_integration_response, params)
  req.send_request(options)
end

#delete_method(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the Method resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

Returns:

  • (Struct) —

    Returns an empty response.



2146
2147
2148
2149
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2146

def delete_method(params = {}, options = {})
  req = build_request(:delete_method, params)
  req.send_request(options)
end

#delete_method_response(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

  • :status_code (required, String) —

    The status code identifier for the MethodResponse resource.

Returns:

  • (Struct) —

    Returns an empty response.



2178
2179
2180
2181
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2178

def delete_method_response(params = {}, options = {})
  req = build_request(:delete_method_response, params)
  req.send_request(options)
end

#delete_model(params = {}) ⇒ Struct

Deletes a model.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :model_name (required, String) —

    The name of the model to delete.

Returns:

  • (Struct) —

    Returns an empty response.



2202
2203
2204
2205
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2202

def delete_model(params = {}, options = {})
  req = build_request(:delete_model, params)
  req.send_request(options)
end

#delete_request_validator(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    The identifier of the RequestValidator to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



2226
2227
2228
2229
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2226

def delete_request_validator(params = {}, options = {})
  req = build_request(:delete_request_validator, params)
  req.send_request(options)
end

#delete_resource(params = {}) ⇒ Struct

Deletes a Resource resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The identifier of the Resource resource.

Returns:

  • (Struct) —

    Returns an empty response.



2250
2251
2252
2253
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2250

def delete_resource(params = {}, options = {})
  req = build_request(:delete_resource, params)
  req.send_request(options)
end

#delete_rest_api(params = {}) ⇒ Struct

Deletes the specified API.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

Returns:

  • (Struct) —

    Returns an empty response.



2270
2271
2272
2273
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2270

def delete_rest_api(params = {}, options = {})
  req = build_request(:delete_rest_api, params)
  req.send_request(options)
end

#delete_stage(params = {}) ⇒ Struct

Deletes a Stage resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the Stage resource to delete.

Returns:

  • (Struct) —

    Returns an empty response.



2294
2295
2296
2297
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2294

def delete_stage(params = {}, options = {})
  req = build_request(:delete_stage, params)
  req.send_request(options)
end

#delete_usage_plan(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

    The Id of the to-be-deleted usage plan.

Returns:

  • (Struct) —

    Returns an empty response.



2314
2315
2316
2317
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2314

def delete_usage_plan(params = {}, options = {})
  req = build_request(:delete_usage_plan, params)
  req.send_request(options)
end

#delete_usage_plan_key(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

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

    The Id of the UsagePlanKey resource to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.



2341
2342
2343
2344
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2341

def delete_usage_plan_key(params = {}, options = {})
  req = build_request(:delete_usage_plan_key, params)
  req.send_request(options)
end

#delete_vpc_link(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.



2362
2363
2364
2365
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2362

def delete_vpc_link(params = {}, options = {})
  req = build_request(:delete_vpc_link, params)
  req.send_request(options)
end

#flush_stage_authorizers_cache(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



2386
2387
2388
2389
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2386

def flush_stage_authorizers_cache(params = {}, options = {})
  req = build_request(:flush_stage_authorizers_cache, params)
  req.send_request(options)
end

#flush_stage_cache(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the stage to flush its cache.

Returns:

  • (Struct) —

    Returns an empty response.



2410
2411
2412
2413
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2410

def flush_stage_cache(params = {}, options = {})
  req = build_request(:flush_stage_cache, params)
  req.send_request(options)
end

#generate_client_certificate(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

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



2455
2456
2457
2458
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2455

def generate_client_certificate(params = {}, options = {})
  req = build_request(:generate_client_certificate, params)
  req.send_request(options)
end

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

Gets information about the current Account resource.

Examples:

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

Parameters:

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

    ({})

Returns:



2480
2481
2482
2483
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2480

def (params = {}, options = {})
  req = build_request(:get_account, params)
  req.send_request(options)
end

#get_api_key(params = {}) ⇒ 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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String) —

    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:



2531
2532
2533
2534
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2531

def get_api_key(params = {}, options = {})
  req = build_request(:get_api_key, params)
  req.send_request(options)
end

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

Gets information about the current ApiKeys resource.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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:



2595
2596
2597
2598
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2595

def get_api_keys(params = {}, options = {})
  req = build_request(:get_api_keys, params)
  req.send_request(options)
end

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

Describe an existing Authorizer resource.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    The identifier of the Authorizer resource.

Returns:



2644
2645
2646
2647
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2644

def get_authorizer(params = {}, options = {})
  req = build_request(:get_authorizer, params)
  req.send_request(options)
end

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

Describe an existing Authorizers resource.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



2692
2693
2694
2695
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2692

def get_authorizers(params = {}, options = {})
  req = build_request(:get_authorizers, params)
  req.send_request(options)
end

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

Describe a BasePathMapping resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain name of the BasePathMapping resource to be described.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

  • :base_path (required, 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 any base path name after the domain name.

Returns:



2734
2735
2736
2737
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2734

def get_base_path_mapping(params = {}, options = {})
  req = build_request(:get_base_path_mapping, params)
  req.send_request(options)
end

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

Represents a collection of BasePathMapping resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_base_path_mappings({
  domain_name: "String", # required
  domain_name_id: "String",
  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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain name of a BasePathMapping resource.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

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



2781
2782
2783
2784
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2781

def get_base_path_mappings(params = {}, options = {})
  req = build_request(:get_base_path_mappings, params)
  req.send_request(options)
end

#get_client_certificate(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String) —

    The identifier of the ClientCertificate resource to be described.

Returns:



2818
2819
2820
2821
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2818

def get_client_certificate(params = {}, options = {})
  req = build_request(:get_client_certificate, params)
  req.send_request(options)
end

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

Gets a collection of ClientCertificate resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



2860
2861
2862
2863
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2860

def get_client_certificates(params = {}, options = {})
  req = build_request(:get_client_certificates, params)
  req.send_request(options)
end

#get_deployment(params = {}) ⇒ 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :deployment_id (required, String) —

    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:



2913
2914
2915
2916
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2913

def get_deployment(params = {}, options = {})
  req = build_request(:get_deployment, params)
  req.send_request(options)
end

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

Gets information about a Deployments collection.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



2959
2960
2961
2962
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2959

def get_deployments(params = {}, options = {})
  req = build_request(:get_deployments, params)
  req.send_request(options)
end

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

Gets a documentation part.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

    The string identifier of the associated RestApi.

Returns:



2997
2998
2999
3000
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 2997

def get_documentation_part(params = {}, options = {})
  req = build_request(:get_documentation_part, params)
  req.send_request(options)
end

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

Gets documentation parts.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



3060
3061
3062
3063
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3060

def get_documentation_parts(params = {}, options = {})
  req = build_request(:get_documentation_parts, params)
  req.send_request(options)
end

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

Gets a documentation version.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

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

Returns:



3094
3095
3096
3097
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3094

def get_documentation_version(params = {}, options = {})
  req = build_request(:get_documentation_version, params)
  req.send_request(options)
end

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

Gets documentation versions.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



3134
3135
3136
3137
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3134

def get_documentation_versions(params = {}, options = {})
  req = build_request(:get_documentation_versions, params)
  req.send_request(options)
end

#get_domain_name(params = {}) ⇒ 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
  domain_name_id: "String",
})

Response structure


resp.domain_name #=> String
resp.domain_name_id #=> String
resp.domain_name_arn #=> 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION", "FAILED"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
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
resp.ownership_verification_certificate_arn #=> String
resp.management_policy #=> String
resp.policy #=> String
resp.routing_mode #=> String, one of "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the DomainName resource.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Required for private custom domain names.

Returns:



3218
3219
3220
3221
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3218

def get_domain_name(params = {}, options = {})
  req = build_request(:get_domain_name, params)
  req.send_request(options)
end

#get_domain_name_access_associations(params = {}) ⇒ Types::DomainNameAccessAssociations

Represents a collection on DomainNameAccessAssociations resources.

Examples:

Request syntax with placeholder values


resp = client.get_domain_name_access_associations({
  position: "String",
  limit: 1,
  resource_owner: "SELF", # accepts SELF, OTHER_ACCOUNTS
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].domain_name_access_association_arn #=> String
resp.items[0].domain_name_arn #=> String
resp.items[0].access_association_source_type #=> String, one of "VPCE"
resp.items[0].access_association_source #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :resource_owner (String) —

    The owner of the domain name access association. Use SELF to only list the domain name access associations owned by your own account. Use OTHER_ACCOUNTS to list the domain name access associations with your private custom domain names that are owned by other AWS accounts.

Returns:



3264
3265
3266
3267
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3264

def get_domain_name_access_associations(params = {}, options = {})
  req = build_request(:get_domain_name_access_associations, params)
  req.send_request(options)
end

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

Represents a collection of DomainName resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_domain_names({
  position: "String",
  limit: 1,
  resource_owner: "SELF", # accepts SELF, OTHER_ACCOUNTS
})

Response structure


resp.position #=> String
resp.items #=> Array
resp.items[0].domain_name #=> String
resp.items[0].domain_name_id #=> String
resp.items[0].domain_name_arn #=> 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION", "FAILED"
resp.items[0].domain_name_status_message #=> String
resp.items[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.items[0].endpoint_access_mode #=> String, one of "BASIC", "STRICT"
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
resp.items[0].ownership_verification_certificate_arn #=> String
resp.items[0].management_policy #=> String
resp.items[0].policy #=> String
resp.items[0].routing_mode #=> String, one of "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING"

Parameters:

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

    ({})

Options Hash (params):

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

  • :resource_owner (String) —

    The owner of the domain name access association.

Returns:



3334
3335
3336
3337
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3334

def get_domain_names(params = {}, options = {})
  req = build_request(:get_domain_names, params)
  req.send_request(options)
end

#get_export(params = {}) ⇒ 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 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the Stage that will be exported.

  • :export_type (required, String) —

    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:



3393
3394
3395
3396
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3393

def get_export(params = {}, options = {})
  req = build_request(:get_export, params)
  req.send_request(options)
end

#get_gateway_response(params = {}) ⇒ 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, WAF_FILTERED
})

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", "WAF_FILTERED"
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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :response_type (required, String) —

    The response type of the associated GatewayResponse.

Returns:



3434
3435
3436
3437
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3434

def get_gateway_response(params = {}, options = {})
  req = build_request(:get_gateway_response, params)
  req.send_request(options)
end

#get_gateway_responses(params = {}) ⇒ 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", "WAF_FILTERED"
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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



3484
3485
3486
3487
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3484

def get_gateway_responses(params = {}, options = {})
  req = build_request(:get_gateway_responses, params)
  req.send_request(options)
end

#get_integration(params = {}) ⇒ 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 #=> Boolean
resp.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.integration_target #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a get integration request's resource identifier

  • :http_method (required, String) —

    Specifies a get integration request's HTTP method.

Returns:



3560
3561
3562
3563
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3560

def get_integration(params = {}, options = {})
  req = build_request(:get_integration, params)
  req.send_request(options)
end

#get_integration_response(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a get integration response request's resource identifier.

  • :http_method (required, String) —

    Specifies a get integration response request's HTTP method.

  • :status_code (required, String) —

    Specifies a get integration response request's status code.

Returns:



3608
3609
3610
3611
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3608

def get_integration_response(params = {}, options = {})
  req = build_request(:get_integration_response, params)
  req.send_request(options)
end

#get_method(params = {}) ⇒ 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 #=> Boolean
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.method_integration.integration_target #=> String
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the Method resource.

  • :http_method (required, String) —

    Specifies the method request's HTTP method type.

Returns:



3696
3697
3698
3699
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3696

def get_method(params = {}, options = {})
  req = build_request(:get_method, params)
  req.send_request(options)
end

#get_method_response(params = {}) ⇒ 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"] #=> Boolean
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

  • :status_code (required, String) —

    The status code for the MethodResponse resource.

Returns:



3740
3741
3742
3743
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3740

def get_method_response(params = {}, options = {})
  req = build_request(:get_method_response, params)
  req.send_request(options)
end

#get_model(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The RestApi identifier under which the Model exists.

  • :model_name (required, String) —

    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:



3784
3785
3786
3787
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3784

def get_model(params = {}, options = {})
  req = build_request(:get_model, params)
  req.send_request(options)
end

#get_model_template(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :model_name (required, String) —

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

Returns:



3815
3816
3817
3818
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3815

def get_model_template(params = {}, options = {})
  req = build_request(:get_model_template, params)
  req.send_request(options)
end

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

Describes existing Models defined for a RestApi resource.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



3859
3860
3861
3862
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3859

def get_models(params = {}, options = {})
  req = build_request(:get_models, params)
  req.send_request(options)
end

#get_request_validator(params = {}) ⇒ 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 #=> Boolean
resp.validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    The identifier of the RequestValidator to be retrieved.

Returns:



3895
3896
3897
3898
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3895

def get_request_validator(params = {}, options = {})
  req = build_request(:get_request_validator, params)
  req.send_request(options)
end

#get_request_validators(params = {}) ⇒ 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 #=> Boolean
resp.items[0].validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



3936
3937
3938
3939
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 3936

def get_request_validators(params = {}, options = {})
  req = build_request(:get_request_validators, params)
  req.send_request(options)
end

#get_resource(params = {}) ⇒ 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 #=> Boolean
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"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.resource_methods["String"].method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.resource_methods["String"].method_integration.integration_target #=> String
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    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:



4029
4030
4031
4032
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4029

def get_resource(params = {}, options = {})
  req = build_request(:get_resource, params)
  req.send_request(options)
end

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

Lists information about a collection of Resource resources.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
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"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.items[0].resource_methods["String"].method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.items[0].resource_methods["String"].method_integration.integration_target #=> String
resp.items[0].resource_methods["String"].authorization_scopes #=> Array
resp.items[0].resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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:



4128
4129
4130
4131
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4128

def get_resources(params = {}, options = {})
  req = build_request(:get_resources, params)
  req.send_request(options)
end

#get_rest_api(params = {}) ⇒ 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.root_resource_id #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

Returns:



4195
4196
4197
4198
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4195

def get_rest_api(params = {}, options = {})
  req = build_request(:get_rest_api, params)
  req.send_request(options)
end

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

Lists the RestApis resources for your collection.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.items[0].root_resource_id #=> String
resp.items[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.items[0].endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.items[0].api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.items[0].api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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



4255
4256
4257
4258
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4255

def get_rest_apis(params = {}, options = {})
  req = build_request(:get_rest_apis, params)
  req.send_request(options)
end

#get_sdk(params = {}) ⇒ 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 #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the Stage that the SDK will use.

  • :sdk_type (required, String) —

    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:



4307
4308
4309
4310
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4307

def get_sdk(params = {}, options = {})
  req = build_request(:get_sdk, params)
  req.send_request(options)
end

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

Gets an SDK type.

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 #=> Boolean
resp.configuration_properties[0].default_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The identifier of the queried SdkType instance.

Returns:



4344
4345
4346
4347
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4344

def get_sdk_type(params = {}, options = {})
  req = build_request(:get_sdk_type, params)
  req.send_request(options)
end

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

Gets SDK types

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 #=> Boolean
resp.items[0].configuration_properties[0].default_value #=> String

Parameters:

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

    ({})

Options Hash (params):

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



4386
4387
4388
4389
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4386

def get_sdk_types(params = {}, options = {})
  req = build_request(:get_sdk_types, params)
  req.send_request(options)
end

#get_stage(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> Boolean
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> Boolean
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> Boolean
resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
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 #=> Boolean
resp.tracing_enabled #=> Boolean
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the Stage resource to get information about.

Returns:



4465
4466
4467
4468
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4465

def get_stage(params = {}, options = {})
  req = build_request(:get_stage, params)
  req.send_request(options)
end

#get_stages(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
resp.item[0].method_settings["String"].logging_level #=> String
resp.item[0].method_settings["String"].data_trace_enabled #=> Boolean
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 #=> Boolean
resp.item[0].method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.item[0].method_settings["String"].cache_data_encrypted #=> Boolean
resp.item[0].method_settings["String"].require_authorization_for_cache_control #=> Boolean
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 #=> Boolean
resp.item[0].tracing_enabled #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :deployment_id (String) —

    The stages' deployment identifiers.

Returns:



4529
4530
4531
4532
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4529

def get_stages(params = {}, options = {})
  req = build_request(:get_stages, params)
  req.send_request(options)
end

#get_tags(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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:



4566
4567
4568
4569
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4566

def get_tags(params = {}, options = {})
  req = build_request(:get_tags, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

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

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

  • :end_date (required, String) —

    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:



4626
4627
4628
4629
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4626

def get_usage(params = {}, options = {})
  req = build_request(:get_usage, params)
  req.send_request(options)
end

#get_usage_plan(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

    The identifier of the UsagePlan resource to be retrieved.

Returns:



4675
4676
4677
4678
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4675

def get_usage_plan(params = {}, options = {})
  req = build_request(:get_usage_plan, params)
  req.send_request(options)
end

#get_usage_plan_key(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

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

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

Returns:



4714
4715
4716
4717
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4714

def get_usage_plan_key(params = {}, options = {})
  req = build_request(:get_usage_plan_key, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

    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:



4765
4766
4767
4768
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4765

def get_usage_plan_keys(params = {}, options = {})
  req = build_request(:get_usage_plan_keys, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



4821
4822
4823
4824
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4821

def get_usage_plans(params = {}, options = {})
  req = build_request(:get_usage_plans, params)
  req.send_request(options)
end

#get_vpc_link(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String) —

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

Returns:



4862
4863
4864
4865
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4862

def get_vpc_link(params = {}, options = {})
  req = build_request(:get_vpc_link, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

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



4907
4908
4909
4910
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4907

def get_vpc_links(params = {}, options = {})
  req = build_request(:get_vpc_links, params)
  req.send_request(options)
end

#import_api_keys(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :body (required, String, StringIO, File) —

    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:



4948
4949
4950
4951
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4948

def import_api_keys(params = {}, options = {})
  req = build_request(:import_api_keys, params)
  req.send_request(options)
end

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

Imports documentation parts

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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, String, StringIO, File) —

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

Returns:



4995
4996
4997
4998
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 4995

def import_documentation_parts(params = {}, options = {})
  req = build_request(:import_documentation_parts, params)
  req.send_request(options)
end

#import_rest_api(params = {}) ⇒ 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.root_resource_id #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :body (required, String, StringIO, File) —

    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:



5091
5092
5093
5094
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5091

def import_rest_api(params = {}, options = {})
  req = build_request(:import_rest_api, params)
  req.send_request(options)
end

#put_gateway_response(params = {}) ⇒ 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, WAF_FILTERED
  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", "WAF_FILTERED"
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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :response_type (required, String) —

    The response type of the associated GatewayResponse

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



5150
5151
5152
5153
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5150

def put_gateway_response(params = {}, options = {})
  req = build_request(:put_gateway_response, params)
  req.send_request(options)
end

#put_integration(params = {}) ⇒ 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_transfer_mode: "BUFFERED", # accepts BUFFERED, STREAM
  integration_target: "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 #=> Boolean
resp.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.integration_target #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a put integration request's resource ID.

  • :http_method (required, String) —

    Specifies the HTTP method for the integration.

  • :type (required, String) —

    Specifies a put integration input's type.

  • :integration_http_method (String) —

    The HTTP method for the integration.

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

  • :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. Specify this value only if you specify VPC_LINK as the connection type.

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

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

    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. You can increase the default value to longer than 29 seconds for Regional or private APIs only.

  • :tls_config (Types::TlsConfig) —

    Specifies the TLS configuration for an integration.

  • :response_transfer_mode (String) —

    The response transfer mode of the integration.

  • :integration_target (String) —

    The ALB or NLB listener to send the request to.

Returns:



5350
5351
5352
5353
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5350

def put_integration(params = {}, options = {})
  req = build_request(:put_integration, params)
  req.send_request(options)
end

#put_integration_response(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a put integration response request's resource identifier.

  • :http_method (required, String) —

    Specifies a put integration response request's HTTP method.

  • :status_code (required, String) —

    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:

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

Returns:



5435
5436
5437
5438
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5435

def put_integration_response(params = {}, options = {})
  req = build_request(:put_integration_response, params)
  req.send_request(options)
end

#put_method(params = {}) ⇒ 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 #=> Boolean
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.method_integration.integration_target #=> String
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the new Method resource.

  • :http_method (required, String) —

    Specifies the method request's HTTP method type.

  • :authorization_type (required, String) —

    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:



5585
5586
5587
5588
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5585

def put_method(params = {}, options = {})
  req = build_request(:put_method, params)
  req.send_request(options)
end

#put_method_response(params = {}) ⇒ 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"] #=> Boolean
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the Method resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

  • :status_code (required, String) —

    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:



5656
5657
5658
5659
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5656

def put_method_response(params = {}, options = {})
  req = build_request(:put_method_response, params)
  req.send_request(options)
end

#put_rest_api(params = {}) ⇒ 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.root_resource_id #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    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, String, StringIO, File) —

    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:



5754
5755
5756
5757
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5754

def put_rest_api(params = {}, options = {})
  req = build_request(:put_rest_api, params)
  req.send_request(options)
end

#reject_domain_name_access_association(params = {}) ⇒ Struct

Rejects a domain name access association with a private custom domain name.

To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.

Examples:

Request syntax with placeholder values


resp = client.reject_domain_name_access_association({
  domain_name_access_association_arn: "String", # required
  domain_name_arn: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name_access_association_arn (required, String) —

    The ARN of the domain name access association resource.

  • :domain_name_arn (required, String) —

    The ARN of the domain name.

Returns:

  • (Struct) —

    Returns an empty response.



5784
5785
5786
5787
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5784

def reject_domain_name_access_association(params = {}, options = {})
  req = build_request(:reject_domain_name_access_association, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ 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",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of a resource that can be tagged.

  • :tags (required, 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:

  • (Struct) —

    Returns an empty response.



5812
5813
5814
5815
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5812

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    Specifies a test invoke authorizer request's Authorizer ID.

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

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

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

    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.

  • :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>) —

    A key-value map of additional context variables.

Returns:



5897
5898
5899
5900
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5897

def test_invoke_authorizer(params = {}, options = {})
  req = build_request(:test_invoke_authorizer, params)
  req.send_request(options)
end

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

Simulate the invocation 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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies a test invoke method request's resource ID.

  • :http_method (required, String) —

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

    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:



5981
5982
5983
5984
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 5981

def test_invoke_method(params = {}, options = {})
  req = build_request(:test_invoke_method, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of a resource that can be tagged.

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

    The Tag keys to delete.

Returns:

  • (Struct) —

    Returns an empty response.



6005
6006
6007
6008
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6005

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_account(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

Returns:



6051
6052
6053
6054
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6051

def (params = {}, options = {})
  req = build_request(:update_account, params)
  req.send_request(options)
end

#update_api_key(params = {}) ⇒ 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 #=> Boolean
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

Parameters:

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

    ({})

Options Hash (params):

  • :api_key (required, String) —

    The identifier of the ApiKey resource to be updated.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6113
6114
6115
6116
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6113

def update_api_key(params = {}, options = {})
  req = build_request(:update_api_key, params)
  req.send_request(options)
end

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

Updates an existing Authorizer resource.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :authorizer_id (required, String) —

    The identifier of the Authorizer resource.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6178
6179
6180
6181
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6178

def update_authorizer(params = {}, options = {})
  req = build_request(:update_authorizer, params)
  req.send_request(options)
end

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

Changes information about the BasePathMapping resource.

Examples:

Request syntax with placeholder values


resp = client.update_base_path_mapping({
  domain_name: "String", # required
  domain_name_id: "String",
  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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain name of the BasePathMapping resource to change.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

  • :base_path (required, String) —

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6235
6236
6237
6238
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6235

def update_base_path_mapping(params = {}, options = {})
  req = build_request(:update_base_path_mapping, params)
  req.send_request(options)
end

#update_client_certificate(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :client_certificate_id (required, String) —

    The identifier of the ClientCertificate resource to be updated.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6288
6289
6290
6291
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6288

def update_client_certificate(params = {}, options = {})
  req = build_request(:update_client_certificate, params)
  req.send_request(options)
end

#update_deployment(params = {}) ⇒ 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6344
6345
6346
6347
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6344

def update_deployment(params = {}, options = {})
  req = build_request(:update_deployment, params)
  req.send_request(options)
end

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

Updates a documentation part.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_part_id (required, String) —

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

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6398
6399
6400
6401
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6398

def update_documentation_part(params = {}, options = {})
  req = build_request(:update_documentation_part, params)
  req.send_request(options)
end

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

Updates a documentation version.

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :documentation_version (required, String) —

    The version identifier of the to-be-updated documentation version.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6448
6449
6450
6451
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6448

def update_documentation_version(params = {}, options = {})
  req = build_request(:update_documentation_version, params)
  req.send_request(options)
end

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

Changes information about the DomainName resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_name #=> String
resp.domain_name_id #=> String
resp.domain_name_arn #=> 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION", "FAILED"
resp.domain_name_status_message #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
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
resp.ownership_verification_certificate_arn #=> String
resp.management_policy #=> String
resp.policy #=> String
resp.routing_mode #=> String, one of "BASE_PATH_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_BASE_PATH_MAPPING"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the DomainName resource to be changed.

  • :domain_name_id (String) —

    The identifier for the domain name resource. Supported only for private custom domain names.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6547
6548
6549
6550
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6547

def update_domain_name(params = {}, options = {})
  req = build_request(:update_domain_name, params)
  req.send_request(options)
end

#update_gateway_response(params = {}) ⇒ 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, WAF_FILTERED
  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", "WAF_FILTERED"
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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :response_type (required, String) —

    The response type of the associated GatewayResponse.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6604
6605
6606
6607
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6604

def update_gateway_response(params = {}, options = {})
  req = build_request(:update_gateway_response, params)
  req.send_request(options)
end

#update_integration(params = {}) ⇒ 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 #=> Boolean
resp.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.integration_target #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Represents an update integration request's resource identifier.

  • :http_method (required, String) —

    Represents an update integration request's HTTP method.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6696
6697
6698
6699
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6696

def update_integration(params = {}, options = {})
  req = build_request(:update_integration, params)
  req.send_request(options)
end

#update_integration_response(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    Specifies an update integration response request's resource identifier.

  • :http_method (required, String) —

    Specifies an update integration response request's HTTP method.

  • :status_code (required, String) —

    Specifies an update integration response request's status code.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6761
6762
6763
6764
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6761

def update_integration_response(params = {}, options = {})
  req = build_request(:update_integration_response, params)
  req.send_request(options)
end

#update_method(params = {}) ⇒ 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 #=> Boolean
resp.request_validator_id #=> String
resp.operation_name #=> String
resp.request_parameters #=> Hash
resp.request_parameters["String"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.method_integration.integration_target #=> String
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the Method resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6865
6866
6867
6868
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6865

def update_method(params = {}, options = {})
  req = build_request(:update_method, params)
  req.send_request(options)
end

#update_method_response(params = {}) ⇒ 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"] #=> Boolean
resp.response_models #=> Hash
resp.response_models["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The Resource identifier for the MethodResponse resource.

  • :http_method (required, String) —

    The HTTP verb of the Method resource.

  • :status_code (required, String) —

    The status code for the MethodResponse resource.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6925
6926
6927
6928
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6925

def update_method_response(params = {}, options = {})
  req = build_request(:update_method_response, params)
  req.send_request(options)
end

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :model_name (required, String) —

    The name of the model to update.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



6980
6981
6982
6983
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 6980

def update_model(params = {}, options = {})
  req = build_request(:update_model, params)
  req.send_request(options)
end

#update_request_validator(params = {}) ⇒ 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 #=> Boolean
resp.validate_request_parameters #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :request_validator_id (required, String) —

    The identifier of RequestValidator to be updated.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7032
7033
7034
7035
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7032

def update_request_validator(params = {}, options = {})
  req = build_request(:update_request_validator, params)
  req.send_request(options)
end

#update_resource(params = {}) ⇒ 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 #=> Boolean
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"] #=> Boolean
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"] #=> Boolean
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 #=> Boolean
resp.resource_methods["String"].method_integration.response_transfer_mode #=> String, one of "BUFFERED", "STREAM"
resp.resource_methods["String"].method_integration.integration_target #=> String
resp.resource_methods["String"].authorization_scopes #=> Array
resp.resource_methods["String"].authorization_scopes[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :resource_id (required, String) —

    The identifier of the Resource resource.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7131
7132
7133
7134
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7131

def update_resource(params = {}, options = {})
  req = build_request(:update_resource, params)
  req.send_request(options)
end

#update_rest_api(params = {}) ⇒ 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.ip_address_type #=> String, one of "ipv4", "dualstack"
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 #=> Boolean
resp.root_resource_id #=> String
resp.security_policy #=> String, one of "TLS_1_0", "TLS_1_2", "SecurityPolicy_TLS13_1_3_2025_09", "SecurityPolicy_TLS13_1_3_FIPS_2025_09", "SecurityPolicy_TLS13_1_2_PFS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_FIPS_PQ_2025_09", "SecurityPolicy_TLS13_1_2_PQ_2025_09", "SecurityPolicy_TLS13_1_2_2021_06", "SecurityPolicy_TLS13_2025_EDGE", "SecurityPolicy_TLS12_PFS_2025_EDGE", "SecurityPolicy_TLS12_2018_EDGE"
resp.endpoint_access_mode #=> String, one of "BASIC", "STRICT"
resp.api_status #=> String, one of "UPDATING", "AVAILABLE", "PENDING", "FAILED"
resp.api_status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7214
7215
7216
7217
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7214

def update_rest_api(params = {}, options = {})
  req = build_request(:update_rest_api, params)
  req.send_request(options)
end

#update_stage(params = {}) ⇒ 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 #=> Boolean
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 #=> Boolean
resp.method_settings["String"].logging_level #=> String
resp.method_settings["String"].data_trace_enabled #=> Boolean
resp.method_settings["String"].throttling_burst_limit #=> Integer
resp.method_settings["String"].throttling_rate_limit #=> Float
resp.method_settings["String"].caching_enabled #=> Boolean
resp.method_settings["String"].cache_ttl_in_seconds #=> Integer
resp.method_settings["String"].cache_data_encrypted #=> Boolean
resp.method_settings["String"].require_authorization_for_cache_control #=> Boolean
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 #=> Boolean
resp.tracing_enabled #=> Boolean
resp.web_acl_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.created_date #=> Time
resp.last_updated_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :rest_api_id (required, String) —

    The string identifier of the associated RestApi.

  • :stage_name (required, String) —

    The name of the Stage resource to change information about.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7309
7310
7311
7312
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7309

def update_stage(params = {}, options = {})
  req = build_request(:update_stage, params)
  req.send_request(options)
end

#update_usage(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

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

  • :key_id (required, String) —

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7368
7369
7370
7371
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7368

def update_usage(params = {}, options = {})
  req = build_request(:update_usage, params)
  req.send_request(options)
end

#update_usage_plan(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :usage_plan_id (required, String) —

    The Id of the to-be-updated usage plan.

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7433
7434
7435
7436
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7433

def update_usage_plan(params = {}, options = {})
  req = build_request(:update_usage_plan, params)
  req.send_request(options)
end

#update_vpc_link(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String) —

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

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

    For more information about supported patch operations, see Patch Operations.

Returns:



7490
7491
7492
7493
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/client.rb', line 7490

def update_vpc_link(params = {}, options = {})
  req = build_request(:update_vpc_link, params)
  req.send_request(options)
end