Class: Aws::ApiGatewayV2::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::ApiGatewayV2::Client

show all

Includes:: ClientStubs

Defined in:: lib/aws-sdk-apigatewayv2/client.rb

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#create_api(params = {}) ⇒ Types::CreateApiResponse

Creates an Api resource.
#create_api_mapping(params = {}) ⇒ Types::CreateApiMappingResponse

Creates an API mapping.
#create_authorizer(params = {}) ⇒ Types::CreateAuthorizerResponse

Creates an Authorizer for an API.
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse

Creates a Deployment for an API.
#create_domain_name(params = {}) ⇒ Types::CreateDomainNameResponse

Creates a domain name.
#create_integration(params = {}) ⇒ Types::CreateIntegrationResult

Creates an Integration.
#create_integration_response(params = {}) ⇒ Types::CreateIntegrationResponseResponse

Creates an IntegrationResponses.
#create_model(params = {}) ⇒ Types::CreateModelResponse

Creates a Model for an API.
#create_route(params = {}) ⇒ Types::CreateRouteResult

Creates a Route for an API.
#create_route_response(params = {}) ⇒ Types::CreateRouteResponseResponse

Creates a RouteResponse for a Route.
#create_stage(params = {}) ⇒ Types::CreateStageResponse

Creates a Stage for an API.
#create_vpc_link(params = {}) ⇒ Types::CreateVpcLinkResponse

Creates a VPC link.
#delete_access_log_settings(params = {}) ⇒ Struct

Deletes the AccessLogSettings for a Stage.
#delete_api(params = {}) ⇒ Struct

Deletes an Api resource.
#delete_api_mapping(params = {}) ⇒ Struct

Deletes an API mapping.
#delete_authorizer(params = {}) ⇒ Struct

Deletes an Authorizer.
#delete_cors_configuration(params = {}) ⇒ Struct

Deletes a CORS configuration.
#delete_deployment(params = {}) ⇒ Struct

Deletes a Deployment.
#delete_domain_name(params = {}) ⇒ Struct

Deletes a domain name.
#delete_integration(params = {}) ⇒ Struct

Deletes an Integration.
#delete_integration_response(params = {}) ⇒ Struct

Deletes an IntegrationResponses.
#delete_model(params = {}) ⇒ Struct

Deletes a Model.
#delete_route(params = {}) ⇒ Struct

Deletes a Route.
#delete_route_request_parameter(params = {}) ⇒ Struct

Deletes a route request parameter.
#delete_route_response(params = {}) ⇒ Struct

Deletes a RouteResponse.
#delete_route_settings(params = {}) ⇒ Struct

Deletes the RouteSettings for a stage.
#delete_stage(params = {}) ⇒ Struct

Deletes a Stage.
#delete_vpc_link(params = {}) ⇒ Struct

Deletes a VPC link.
#export_api(params = {}) ⇒ Types::ExportApiResponse

Exports a definition of an API in a particular output format and specification.
#get_api(params = {}) ⇒ Types::GetApiResponse

Gets an Api resource.
#get_api_mapping(params = {}) ⇒ Types::GetApiMappingResponse

Gets an API mapping.
#get_api_mappings(params = {}) ⇒ Types::GetApiMappingsResponse

Gets API mappings.
#get_apis(params = {}) ⇒ Types::GetApisResponse

Gets a collection of Api resources.
#get_authorizer(params = {}) ⇒ Types::GetAuthorizerResponse

Gets an Authorizer.
#get_authorizers(params = {}) ⇒ Types::GetAuthorizersResponse

Gets the Authorizers for an API.
#get_deployment(params = {}) ⇒ Types::GetDeploymentResponse

Gets a Deployment.
#get_deployments(params = {}) ⇒ Types::GetDeploymentsResponse

Gets the Deployments for an API.
#get_domain_name(params = {}) ⇒ Types::GetDomainNameResponse

Gets a domain name.
#get_domain_names(params = {}) ⇒ Types::GetDomainNamesResponse

Gets the domain names for an AWS account.
#get_integration(params = {}) ⇒ Types::GetIntegrationResult

Gets an Integration.
#get_integration_response(params = {}) ⇒ Types::GetIntegrationResponseResponse

Gets an IntegrationResponses.
#get_integration_responses(params = {}) ⇒ Types::GetIntegrationResponsesResponse

Gets the IntegrationResponses for an Integration.
#get_integrations(params = {}) ⇒ Types::GetIntegrationsResponse

Gets the Integrations for an API.
#get_model(params = {}) ⇒ Types::GetModelResponse

Gets a Model.
#get_model_template(params = {}) ⇒ Types::GetModelTemplateResponse

Gets a model template.
#get_models(params = {}) ⇒ Types::GetModelsResponse

Gets the Models for an API.
#get_route(params = {}) ⇒ Types::GetRouteResult

Gets a Route.
#get_route_response(params = {}) ⇒ Types::GetRouteResponseResponse

Gets a RouteResponse.
#get_route_responses(params = {}) ⇒ Types::GetRouteResponsesResponse

Gets the RouteResponses for a Route.
#get_routes(params = {}) ⇒ Types::GetRoutesResponse

Gets the Routes for an API.
#get_stage(params = {}) ⇒ Types::GetStageResponse

Gets a Stage.
#get_stages(params = {}) ⇒ Types::GetStagesResponse

Gets the Stages for an API.
#get_tags(params = {}) ⇒ Types::GetTagsResponse

Gets a collection of Tag resources.
#get_vpc_link(params = {}) ⇒ Types::GetVpcLinkResponse

Gets a VPC link.
#get_vpc_links(params = {}) ⇒ Types::GetVpcLinksResponse

Gets a collection of VPC links.
#import_api(params = {}) ⇒ Types::ImportApiResponse

Imports an API.
#reimport_api(params = {}) ⇒ Types::ReimportApiResponse

Puts an Api resource.
#reset_authorizers_cache(params = {}) ⇒ Struct

Resets all authorizer cache entries for the specified stage.
#tag_resource(params = {}) ⇒ Struct

Creates a new Tag resource to represent a tag.
#untag_resource(params = {}) ⇒ Struct

Deletes a Tag.
#update_api(params = {}) ⇒ Types::UpdateApiResponse

Updates an Api resource.
#update_api_mapping(params = {}) ⇒ Types::UpdateApiMappingResponse

The API mapping.
#update_authorizer(params = {}) ⇒ Types::UpdateAuthorizerResponse

Updates an Authorizer.
#update_deployment(params = {}) ⇒ Types::UpdateDeploymentResponse

Updates a Deployment.
#update_domain_name(params = {}) ⇒ Types::UpdateDomainNameResponse

Updates a domain name.
#update_integration(params = {}) ⇒ Types::UpdateIntegrationResult

Updates an Integration.
#update_integration_response(params = {}) ⇒ Types::UpdateIntegrationResponseResponse

Updates an IntegrationResponses.
#update_model(params = {}) ⇒ Types::UpdateModelResponse

Updates a Model.
#update_route(params = {}) ⇒ Types::UpdateRouteResult

Updates a Route.
#update_route_response(params = {}) ⇒ Types::UpdateRouteResponseResponse

Updates a RouteResponse.
#update_stage(params = {}) ⇒ Types::UpdateStageResponse

Updates a Stage.
#update_vpc_link(params = {}) ⇒ Types::UpdateVpcLinkResponse

Updates a VPC link.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ Client constructor

A new instance of Client.
#waiter_names ⇒ Object deprecated private Deprecated.

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. This can be an 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`
- The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.
- ENV, ENV, ENV, and ENV
- ‘~/.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 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`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.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.
: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 —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
: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_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.
: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 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`
- ‘ENV`
- ‘~/.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) —
A Bearer Token Provider. This can be an 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::ApiGatewayV2::EndpointProvider) —

The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ApiGatewayV2::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 ‘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.



444
445
446

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 444

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



4598
4599
4600

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4598

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



4601
4602
4603

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4601

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4571

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::ApiGatewayV2')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-apigatewayv2'
  context[:gem_version] = '1.68.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_api(params = {}) ⇒ `Types::CreateApiResponse`

Creates an Api resource.

Examples:

Request syntax with placeholder values


resp = client.create_api({
  api_key_selection_expression: "SelectionExpression",
  cors_configuration: {
    allow_credentials: false,
    allow_headers: ["__string"],
    allow_methods: ["StringWithLengthBetween1And64"],
    allow_origins: ["__string"],
    expose_headers: ["__string"],
    max_age: 1,
  },
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  disable_schema_validation: false,
  disable_execute_api_endpoint: false,
  name: "StringWithLengthBetween1And128", # required
  protocol_type: "WEBSOCKET", # required, accepts WEBSOCKET, HTTP
  route_key: "SelectionKey",
  route_selection_expression: "SelectionExpression",
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
  target: "UriWithLengthBetween1And2048",
  version: "StringWithLengthBetween1And64",
})

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.name #=> String
resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.route_selection_expression #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

({})

Options Hash (params):

:api_key_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:cors_configuration (Types::Cors) —

Represents a CORS configuration. Supported only for HTTP APIs. See

Configuring CORS][1

for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
:credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:description (String) —

A string with a length between [0-1024].
:disable_schema_validation (Boolean)
:disable_execute_api_endpoint (Boolean)
:name (required, String) —

A string with a length between [1-128].
:protocol_type (required, String) —

Represents a protocol type.
:route_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:route_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:tags (Hash<String,String>) —

Represents a collection of tags associated with the resource.
:target (String) —

A string representation of a URI with a length between [1-2048].
:version (String) —

A string with a length between [1-64].

Returns:

(Types::CreateApiResponse) —
Returns a response object which responds to the following methods:
- #api_endpoint => String
- #api_gateway_managed => Boolean
- #api_id => String
- #api_key_selection_expression => String
- #cors_configuration => Types::Cors
- #created_date => Time
- #description => String
- #disable_schema_validation => Boolean
- #disable_execute_api_endpoint => Boolean
- #import_info => Array<String>
- #name => String
- #protocol_type => String
- #route_selection_expression => String
- #tags => Hash<String,String>
- #version => String
- #warnings => Array<String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 590

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

#create_api_mapping(params = {}) ⇒ `Types::CreateApiMappingResponse`

Creates an API mapping.

Examples:

Request syntax with placeholder values


resp = client.create_api_mapping({
  api_id: "Id", # required
  api_mapping_key: "SelectionKey",
  domain_name: "__string", # required
  stage: "StringWithLengthBetween1And128", # required
})

Response structure


resp.api_id #=> String
resp.api_mapping_id #=> String
resp.api_mapping_key #=> String
resp.stage #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String) —

The identifier.
:api_mapping_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:domain_name (required, String)
:stage (required, String) —

A string with a length between [1-128].

Returns:

(Types::CreateApiMappingResponse) —
Returns a response object which responds to the following methods:
- #api_id => String
- #api_mapping_id => String
- #api_mapping_key => String
- #stage => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 640

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

#create_authorizer(params = {}) ⇒ `Types::CreateAuthorizerResponse`

Creates an Authorizer for an API.

Examples:

Request syntax with placeholder values


resp = client.create_authorizer({
  api_id: "__string", # required
  authorizer_credentials_arn: "Arn",
  authorizer_result_ttl_in_seconds: 1,
  authorizer_type: "REQUEST", # required, accepts REQUEST, JWT
  authorizer_uri: "UriWithLengthBetween1And2048",
  identity_source: ["__string"], # required
  identity_validation_expression: "StringWithLengthBetween0And1024",
  jwt_configuration: {
    audience: ["__string"],
    issuer: "UriWithLengthBetween1And2048",
  },
  name: "StringWithLengthBetween1And128", # required
  authorizer_payload_format_version: "StringWithLengthBetween1And64",
  enable_simple_responses: false,
})

Response structure


resp.authorizer_credentials_arn #=> String
resp.authorizer_id #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer
resp.authorizer_type #=> String, one of "REQUEST", "JWT"
resp.authorizer_uri #=> String
resp.identity_source #=> Array
resp.identity_source[0] #=> String
resp.identity_validation_expression #=> String
resp.jwt_configuration.audience #=> Array
resp.jwt_configuration.audience[0] #=> String
resp.jwt_configuration.issuer #=> String
resp.name #=> String
resp.authorizer_payload_format_version #=> String
resp.enable_simple_responses #=> Boolean

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:authorizer_credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:authorizer_result_ttl_in_seconds (Integer) —

An integer with a value between [0-3600].
:authorizer_type (required, String) —

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
:authorizer_uri (String) —

A string representation of a URI with a length between [1-2048].
:identity_source (required, Array<String>) —

The identity source for which authorization is requested. 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 string with a length between [0-1024].
:jwt_configuration (Types::JWTConfiguration) —

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
:name (required, String) —

A string with a length between [1-128].
:authorizer_payload_format_version (String) —

A string with a length between [1-64].
:enable_simple_responses (Boolean)

Returns:

(Types::CreateAuthorizerResponse) —
Returns a response object which responds to the following methods:
- #authorizer_credentials_arn => String
- #authorizer_id => String
- #authorizer_result_ttl_in_seconds => Integer
- #authorizer_type => String
- #authorizer_uri => String
- #identity_source => Array<String>
- #identity_validation_expression => String
- #jwt_configuration => Types::JWTConfiguration
- #name => String
- #authorizer_payload_format_version => String
- #enable_simple_responses => Boolean

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 747

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

#create_deployment(params = {}) ⇒ `Types::CreateDeploymentResponse`

Creates a Deployment for an API.

Examples:

Request syntax with placeholder values


resp = client.create_deployment({
  api_id: "__string", # required
  description: "StringWithLengthBetween0And1024",
  stage_name: "StringWithLengthBetween1And128",
})

Response structure


resp.auto_deployed #=> Boolean
resp.created_date #=> Time
resp.deployment_id #=> String
resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
resp.deployment_status_message #=> String
resp.description #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:description (String) —

A string with a length between [0-1024].
:stage_name (String) —

A string with a length between [1-128].

Returns:

(Types::CreateDeploymentResponse) —
Returns a response object which responds to the following methods:
- #auto_deployed => Boolean
- #created_date => Time
- #deployment_id => String
- #deployment_status => String
- #deployment_status_message => String
- #description => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 790

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

#create_domain_name(params = {}) ⇒ `Types::CreateDomainNameResponse`

Creates a domain name.

Examples:

Request syntax with placeholder values


resp = client.create_domain_name({
  domain_name: "StringWithLengthBetween1And512", # required
  domain_name_configurations: [
    {
      api_gateway_domain_name: "__string",
      certificate_arn: "Arn",
      certificate_name: "StringWithLengthBetween1And128",
      certificate_upload_date: Time.now,
      domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, PENDING_OWNERSHIP_VERIFICATION
      domain_name_status_message: "__string",
      endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
      hosted_zone_id: "__string",
      security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
      ownership_verification_certificate_arn: "Arn",
    },
  ],
  mutual_tls_authentication: {
    truststore_uri: "UriWithLengthBetween1And2048",
    truststore_version: "StringWithLengthBetween1And64",
  },
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
})

Response structure


resp.api_mapping_selection_expression #=> String
resp.domain_name #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> 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.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:domain_name (required, String) —

A string with a length between [1-512].
:domain_name_configurations (Array<Types::DomainNameConfiguration>) —

The domain name configurations.
:mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
:tags (Hash<String,String>) —

Represents a collection of tags associated with the resource.

Returns:

(Types::CreateDomainNameResponse) —
Returns a response object which responds to the following methods:
- #api_mapping_selection_expression => String
- #domain_name => String
- #domain_name_configurations => Array<Types::DomainNameConfiguration>
- #mutual_tls_authentication => Types::MutualTlsAuthentication
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 870

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

#create_integration(params = {}) ⇒ `Types::CreateIntegrationResult`

Creates an Integration.

Examples:

Request syntax with placeholder values


resp = client.create_integration({
  api_id: "__string", # required
  connection_id: "StringWithLengthBetween1And1024",
  connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  integration_method: "StringWithLengthBetween1And64",
  integration_subtype: "StringWithLengthBetween1And128",
  integration_type: "AWS", # required, accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY
  integration_uri: "UriWithLengthBetween1And2048",
  passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES
  payload_format_version: "StringWithLengthBetween1And64",
  request_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_parameters: {
    "__string" => {
      "__string" => "StringWithLengthBetween1And512",
    },
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
  tls_config: {
    server_name_to_verify: "StringWithLengthBetween1And512",
  },
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.connection_id #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.credentials_arn #=> String
resp.description #=> String
resp.integration_id #=> String
resp.integration_method #=> String
resp.integration_response_selection_expression #=> String
resp.integration_subtype #=> String
resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.integration_uri #=> String
resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
resp.payload_format_version #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> Hash
resp.response_parameters["__string"]["__string"] #=> String
resp.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer
resp.tls_config.server_name_to_verify #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:connection_id (String) —

A string with a length between [1-1024].
:connection_type (String) —

Represents a connection type.
:content_handling_strategy (String) —

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
:credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:description (String) —

A string with a length between [0-1024].
:integration_method (String) —

A string with a length between [1-64].
:integration_subtype (String) —

A string with a length between [1-128].
:integration_type (required, String) —

Represents an API method integration type.
:integration_uri (String) —

A string representation of a URI with a length between [1-2048].
:passthrough_behavior (String) —

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
:payload_format_version (String) —

A string with a length between [1-64].
:request_parameters (Hash<String,String>) —

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs].

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
:response_parameters (Hash<String,Hash>) —

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
:request_templates (Hash<String,String>) —

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
:template_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:timeout_in_millis (Integer) —

An integer with a value between [50-30000].
:tls_config (Types::TlsConfigInput) —

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Returns:

(Types::CreateIntegrationResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #connection_id => String
- #connection_type => String
- #content_handling_strategy => String
- #credentials_arn => String
- #description => String
- #integration_id => String
- #integration_method => String
- #integration_response_selection_expression => String
- #integration_subtype => String
- #integration_type => String
- #integration_uri => String
- #passthrough_behavior => String
- #payload_format_version => String
- #request_parameters => Hash<String,String>
- #response_parameters => Hash<String,Hash<String,String>>
- #request_templates => Hash<String,String>
- #template_selection_expression => String
- #timeout_in_millis => Integer
- #tls_config => Types::TlsConfig

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1058

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

#create_integration_response(params = {}) ⇒ `Types::CreateIntegrationResponseResponse`

Creates an IntegrationResponses.

Examples:

Request syntax with placeholder values


resp = client.create_integration_response({
  api_id: "__string", # required
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  integration_id: "__string", # required
  integration_response_key: "SelectionKey", # required
  response_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
})

Response structure


resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.integration_response_id #=> String
resp.integration_response_key #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> String
resp.response_templates #=> Hash
resp.response_templates["__string"] #=> String
resp.template_selection_expression #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:content_handling_strategy (String) —

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
:integration_id (required, String)
:integration_response_key (required, String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:response_parameters (Hash<String,String>) —

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs].

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
:response_templates (Hash<String,String>) —

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
:template_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(Types::CreateIntegrationResponseResponse) —
Returns a response object which responds to the following methods:
- #content_handling_strategy => String
- #integration_response_id => String
- #integration_response_key => String
- #response_parameters => Hash<String,String>
- #response_templates => Hash<String,String>
- #template_selection_expression => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1167

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

#create_model(params = {}) ⇒ `Types::CreateModelResponse`

Creates a Model for an API.

Examples:

Request syntax with placeholder values


resp = client.create_model({
  api_id: "__string", # required
  content_type: "StringWithLengthBetween1And256",
  description: "StringWithLengthBetween0And1024",
  name: "StringWithLengthBetween1And128", # required
  schema: "StringWithLengthBetween0And32K", # required
})

Response structure


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

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:content_type (String) —

A string with a length between [1-256].
:description (String) —

A string with a length between [0-1024].
:name (required, String) —

A string with a length between [1-128].
:schema (required, String) —

A string with a length between [0-32768].

Returns:

(Types::CreateModelResponse) —
Returns a response object which responds to the following methods:
- #content_type => String
- #description => String
- #model_id => String
- #name => String
- #schema => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1216

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

#create_route(params = {}) ⇒ `Types::CreateRouteResult`

Creates a Route for an API.

Examples:

Request syntax with placeholder values


resp = client.create_route({
  api_id: "__string", # required
  api_key_required: false,
  authorization_scopes: ["StringWithLengthBetween1And64"],
  authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM, JWT
  authorizer_id: "Id",
  model_selection_expression: "SelectionExpression",
  operation_name: "StringWithLengthBetween1And64",
  request_models: {
    "__string" => "StringWithLengthBetween1And128",
  },
  request_parameters: {
    "__string" => {
      required: false,
    },
  },
  route_key: "SelectionKey", # required
  route_response_selection_expression: "SelectionExpression",
  target: "StringWithLengthBetween1And128",
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.api_key_required #=> Boolean
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String
resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
resp.authorizer_id #=> String
resp.model_selection_expression #=> String
resp.operation_name #=> String
resp.request_models #=> Hash
resp.request_models["__string"] #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"].required #=> Boolean
resp.route_id #=> String
resp.route_key #=> String
resp.route_response_selection_expression #=> String
resp.target #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:api_key_required (Boolean)
:authorization_scopes (Array<String>) —

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

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
:authorizer_id (String) —

The identifier.
:model_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:operation_name (String) —

A string with a length between [1-64].
:request_models (Hash<String,String>) —

The route models.
:request_parameters (Hash<String,Types::ParameterConstraints>) —

The route parameters.
:route_key (required, String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:route_response_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:target (String) —

A string with a length between [1-128].

Returns:

(Types::CreateRouteResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #api_key_required => Boolean
- #authorization_scopes => Array<String>
- #authorization_type => String
- #authorizer_id => String
- #model_selection_expression => String
- #operation_name => String
- #request_models => Hash<String,String>
- #request_parameters => Hash<String,Types::ParameterConstraints>
- #route_id => String
- #route_key => String
- #route_response_selection_expression => String
- #target => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1345

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

#create_route_response(params = {}) ⇒ `Types::CreateRouteResponseResponse`

Creates a RouteResponse for a Route.

Examples:

Request syntax with placeholder values


resp = client.create_route_response({
  api_id: "__string", # required
  model_selection_expression: "SelectionExpression",
  response_models: {
    "__string" => "StringWithLengthBetween1And128",
  },
  response_parameters: {
    "__string" => {
      required: false,
    },
  },
  route_id: "__string", # required
  route_response_key: "SelectionKey", # required
})

Response structure


resp.model_selection_expression #=> String
resp.response_models #=> Hash
resp.response_models["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"].required #=> Boolean
resp.route_response_id #=> String
resp.route_response_key #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:model_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:response_models (Hash<String,String>) —

The route models.
:response_parameters (Hash<String,Types::ParameterConstraints>) —

The route parameters.
:route_id (required, String)
:route_response_key (required, String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(Types::CreateRouteResponseResponse) —
Returns a response object which responds to the following methods:
- #model_selection_expression => String
- #response_models => Hash<String,String>
- #response_parameters => Hash<String,Types::ParameterConstraints>
- #route_response_id => String
- #route_response_key => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1417

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

#create_stage(params = {}) ⇒ `Types::CreateStageResponse`

Creates a Stage for an API.

Examples:

Request syntax with placeholder values


resp = client.create_stage({
  access_log_settings: {
    destination_arn: "Arn",
    format: "StringWithLengthBetween1And1024",
  },
  api_id: "__string", # required
  auto_deploy: false,
  client_certificate_id: "Id",
  default_route_settings: {
    data_trace_enabled: false,
    detailed_metrics_enabled: false,
    logging_level: "ERROR", # accepts ERROR, INFO, OFF
    throttling_burst_limit: 1,
    throttling_rate_limit: 1.0,
  },
  deployment_id: "Id",
  description: "StringWithLengthBetween0And1024",
  route_settings: {
    "__string" => {
      data_trace_enabled: false,
      detailed_metrics_enabled: false,
      logging_level: "ERROR", # accepts ERROR, INFO, OFF
      throttling_burst_limit: 1,
      throttling_rate_limit: 1.0,
    },
  },
  stage_name: "StringWithLengthBetween1And128", # required
  stage_variables: {
    "__string" => "StringWithLengthBetween0And2048",
  },
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
})

Response structure


resp.access_log_settings.destination_arn #=> String
resp.access_log_settings.format #=> String
resp.api_gateway_managed #=> Boolean
resp.auto_deploy #=> Boolean
resp.client_certificate_id #=> String
resp.created_date #=> Time
resp.default_route_settings.data_trace_enabled #=> Boolean
resp.default_route_settings.detailed_metrics_enabled #=> Boolean
resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.default_route_settings.throttling_burst_limit #=> Integer
resp.default_route_settings.throttling_rate_limit #=> Float
resp.deployment_id #=> String
resp.description #=> String
resp.last_deployment_status_message #=> String
resp.last_updated_date #=> Time
resp.route_settings #=> Hash
resp.route_settings["__string"].data_trace_enabled #=> Boolean
resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.route_settings["__string"].throttling_burst_limit #=> Integer
resp.route_settings["__string"].throttling_rate_limit #=> Float
resp.stage_name #=> String
resp.stage_variables #=> Hash
resp.stage_variables["__string"] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:access_log_settings (Types::AccessLogSettings) —

Settings for logging access in a stage.
:api_id (required, String)
:auto_deploy (Boolean)
:client_certificate_id (String) —

The identifier.
:default_route_settings (Types::RouteSettings) —

Represents a collection of route settings.
:deployment_id (String) —

The identifier.
:description (String) —

A string with a length between [0-1024].
:route_settings (Hash<String,Types::RouteSettings>) —

The route settings map.
:stage_name (required, String) —

A string with a length between [1-128].
:stage_variables (Hash<String,String>) —

The stage variable map.
:tags (Hash<String,String>) —

Represents a collection of tags associated with the resource.

Returns:

(Types::CreateStageResponse) —
Returns a response object which responds to the following methods:
- #access_log_settings => Types::AccessLogSettings
- #api_gateway_managed => Boolean
- #auto_deploy => Boolean
- #client_certificate_id => String
- #created_date => Time
- #default_route_settings => Types::RouteSettings
- #deployment_id => String
- #description => String
- #last_deployment_status_message => String
- #last_updated_date => Time
- #route_settings => Hash<String,Types::RouteSettings>
- #stage_name => String
- #stage_variables => Hash<String,String>
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1540

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

#create_vpc_link(params = {}) ⇒ `Types::CreateVpcLinkResponse`

Creates a VPC link.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_link({
  name: "StringWithLengthBetween1And128", # required
  security_group_ids: ["__string"],
  subnet_ids: ["__string"], # required
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
})

Response structure


resp.created_date #=> Time
resp.name #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vpc_link_id #=> String
resp.vpc_link_status #=> String, one of "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE"
resp.vpc_link_status_message #=> String
resp.vpc_link_version #=> String, one of "V2"

Parameters:

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

({})

Options Hash (params):

:name (required, String) —

A string with a length between [1-128].
:security_group_ids (Array<String>) —

A list of security group IDs for the VPC link.
:subnet_ids (required, Array<String>) —

A list of subnet IDs to include in the VPC link.
:tags (Hash<String,String>) —

Represents a collection of tags associated with the resource.

Returns:

(Types::CreateVpcLinkResponse) —
Returns a response object which responds to the following methods:
- #created_date => Time
- #name => String
- #security_group_ids => Array<String>
- #subnet_ids => Array<String>
- #tags => Hash<String,String>
- #vpc_link_id => String
- #vpc_link_status => String
- #vpc_link_status_message => String
- #vpc_link_version => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1599

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

#delete_access_log_settings(params = {}) ⇒ `Struct`

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

Examples:

Request syntax with placeholder values


resp = client.delete_access_log_settings({
  api_id: "__string", # required
  stage_name: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:stage_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1622

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

#delete_api(params = {}) ⇒ `Struct`

Deletes an Api resource.

Examples:

Request syntax with placeholder values


resp = client.delete_api({
  api_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1641

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

#delete_api_mapping(params = {}) ⇒ `Struct`

Deletes an API mapping.

Examples:

Request syntax with placeholder values


resp = client.delete_api_mapping({
  api_mapping_id: "__string", # required
  domain_name: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_mapping_id (required, String)
:domain_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1663

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

#delete_authorizer(params = {}) ⇒ `Struct`

Deletes an Authorizer.

Examples:

Request syntax with placeholder values


resp = client.delete_authorizer({
  api_id: "__string", # required
  authorizer_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:authorizer_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1685

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

#delete_cors_configuration(params = {}) ⇒ `Struct`

Deletes a CORS configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_cors_configuration({
  api_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1704

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

#delete_deployment(params = {}) ⇒ `Struct`

Deletes a Deployment.

Examples:

Request syntax with placeholder values


resp = client.delete_deployment({
  api_id: "__string", # required
  deployment_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:deployment_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1726

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

#delete_domain_name(params = {}) ⇒ `Struct`

Deletes a domain name.

Examples:

Request syntax with placeholder values


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

Parameters:

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

({})

Options Hash (params):

:domain_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1745

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

#delete_integration(params = {}) ⇒ `Struct`

Deletes an Integration.

Examples:

Request syntax with placeholder values


resp = client.delete_integration({
  api_id: "__string", # required
  integration_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:integration_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1767

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

#delete_integration_response(params = {}) ⇒ `Struct`

Deletes an IntegrationResponses.

Examples:

Request syntax with placeholder values


resp = client.delete_integration_response({
  api_id: "__string", # required
  integration_id: "__string", # required
  integration_response_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:integration_id (required, String)
:integration_response_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1792

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

#delete_model(params = {}) ⇒ `Struct`

Deletes a Model.

Examples:

Request syntax with placeholder values


resp = client.delete_model({
  api_id: "__string", # required
  model_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:model_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1814

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

#delete_route(params = {}) ⇒ `Struct`

Deletes a Route.

Examples:

Request syntax with placeholder values


resp = client.delete_route({
  api_id: "__string", # required
  route_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:route_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1836

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

#delete_route_request_parameter(params = {}) ⇒ `Struct`

Deletes a route request parameter.

Examples:

Request syntax with placeholder values


resp = client.delete_route_request_parameter({
  api_id: "__string", # required
  request_parameter_key: "__string", # required
  route_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:request_parameter_key (required, String)
:route_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1861

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

#delete_route_response(params = {}) ⇒ `Struct`

Deletes a RouteResponse.

Examples:

Request syntax with placeholder values


resp = client.delete_route_response({
  api_id: "__string", # required
  route_id: "__string", # required
  route_response_id: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:route_id (required, String)
:route_response_id (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1886

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

#delete_route_settings(params = {}) ⇒ `Struct`

Deletes the RouteSettings for a stage.

Examples:

Request syntax with placeholder values


resp = client.delete_route_settings({
  api_id: "__string", # required
  route_key: "__string", # required
  stage_name: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:route_key (required, String)
:stage_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1911

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

#delete_stage(params = {}) ⇒ `Struct`

Deletes a Stage.

Examples:

Request syntax with placeholder values


resp = client.delete_stage({
  api_id: "__string", # required
  stage_name: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:stage_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1933

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

#delete_vpc_link(params = {}) ⇒ `Struct`

Deletes a VPC link.

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)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1952

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

#export_api(params = {}) ⇒ `Types::ExportApiResponse`

Exports a definition of an API in a particular output format and specification.

Examples:

Request syntax with placeholder values


resp = client.export_api({
  api_id: "__string", # required
  export_version: "__string",
  include_extensions: false,
  output_type: "__string", # required
  specification: "__string", # required
  stage_name: "__string",
})

Response structure


resp.body #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:export_version (String)
:include_extensions (Boolean)
:output_type (required, String)
:specification (required, String)
:stage_name (String)

Returns:

(Types::ExportApiResponse) —
Returns a response object which responds to the following methods:
- #body => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1993

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

#get_api(params = {}) ⇒ `Types::GetApiResponse`

Gets an Api resource.

Examples:

Request syntax with placeholder values


resp = client.get_api({
  api_id: "__string", # required
})

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.name #=> String
resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.route_selection_expression #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)

Returns:

(Types::GetApiResponse) —
Returns a response object which responds to the following methods:
- #api_endpoint => String
- #api_gateway_managed => Boolean
- #api_id => String
- #api_key_selection_expression => String
- #cors_configuration => Types::Cors
- #created_date => Time
- #description => String
- #disable_schema_validation => Boolean
- #disable_execute_api_endpoint => Boolean
- #import_info => Array<String>
- #name => String
- #protocol_type => String
- #route_selection_expression => String
- #tags => Hash<String,String>
- #version => String
- #warnings => Array<String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2083

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

#get_api_mapping(params = {}) ⇒ `Types::GetApiMappingResponse`

Gets an API mapping.

Examples:

Request syntax with placeholder values


resp = client.get_api_mapping({
  api_mapping_id: "__string", # required
  domain_name: "__string", # required
})

Response structure


resp.api_id #=> String
resp.api_mapping_id #=> String
resp.api_mapping_key #=> String
resp.stage #=> String

Parameters:

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

({})

Options Hash (params):

:api_mapping_id (required, String)
:domain_name (required, String)

Returns:

(Types::GetApiMappingResponse) —
Returns a response object which responds to the following methods:
- #api_id => String
- #api_mapping_id => String
- #api_mapping_key => String
- #stage => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2117

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

#get_api_mappings(params = {}) ⇒ `Types::GetApiMappingsResponse`

Gets API mappings.

Examples:

Request syntax with placeholder values


resp = client.get_api_mappings({
  domain_name: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].api_id #=> String
resp.items[0].api_mapping_id #=> String
resp.items[0].api_mapping_key #=> String
resp.items[0].stage #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:domain_name (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetApiMappingsResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::ApiMapping>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2154

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

#get_apis(params = {}) ⇒ `Types::GetApisResponse`

Gets a collection of Api resources.

Examples:

Request syntax with placeholder values


resp = client.get_apis({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].api_endpoint #=> String
resp.items[0].api_gateway_managed #=> Boolean
resp.items[0].api_id #=> String
resp.items[0].api_key_selection_expression #=> String
resp.items[0].cors_configuration.allow_credentials #=> Boolean
resp.items[0].cors_configuration.allow_headers #=> Array
resp.items[0].cors_configuration.allow_headers[0] #=> String
resp.items[0].cors_configuration.allow_methods #=> Array
resp.items[0].cors_configuration.allow_methods[0] #=> String
resp.items[0].cors_configuration.allow_origins #=> Array
resp.items[0].cors_configuration.allow_origins[0] #=> String
resp.items[0].cors_configuration.expose_headers #=> Array
resp.items[0].cors_configuration.expose_headers[0] #=> String
resp.items[0].cors_configuration.max_age #=> Integer
resp.items[0].created_date #=> Time
resp.items[0].description #=> String
resp.items[0].disable_schema_validation #=> Boolean
resp.items[0].disable_execute_api_endpoint #=> Boolean
resp.items[0].import_info #=> Array
resp.items[0].import_info[0] #=> String
resp.items[0].name #=> String
resp.items[0].protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.items[0].route_selection_expression #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.items[0].version #=> String
resp.items[0].warnings #=> Array
resp.items[0].warnings[0] #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:max_results (String)
:next_token (String)

Returns:

(Types::GetApisResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Api>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2212

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

#get_authorizer(params = {}) ⇒ `Types::GetAuthorizerResponse`

Gets an Authorizer.

Examples:

Request syntax with placeholder values


resp = client.get_authorizer({
  api_id: "__string", # required
  authorizer_id: "__string", # required
})

Response structure


resp.authorizer_credentials_arn #=> String
resp.authorizer_id #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer
resp.authorizer_type #=> String, one of "REQUEST", "JWT"
resp.authorizer_uri #=> String
resp.identity_source #=> Array
resp.identity_source[0] #=> String
resp.identity_validation_expression #=> String
resp.jwt_configuration.audience #=> Array
resp.jwt_configuration.audience[0] #=> String
resp.jwt_configuration.issuer #=> String
resp.name #=> String
resp.authorizer_payload_format_version #=> String
resp.enable_simple_responses #=> Boolean

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:authorizer_id (required, String)

Returns:

(Types::GetAuthorizerResponse) —
Returns a response object which responds to the following methods:
- #authorizer_credentials_arn => String
- #authorizer_id => String
- #authorizer_result_ttl_in_seconds => Integer
- #authorizer_type => String
- #authorizer_uri => String
- #identity_source => Array<String>
- #identity_validation_expression => String
- #jwt_configuration => Types::JWTConfiguration
- #name => String
- #authorizer_payload_format_version => String
- #enable_simple_responses => Boolean

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2263

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

#get_authorizers(params = {}) ⇒ `Types::GetAuthorizersResponse`

Gets the Authorizers for an API.

Examples:

Request syntax with placeholder values


resp = client.get_authorizers({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].authorizer_credentials_arn #=> String
resp.items[0].authorizer_id #=> String
resp.items[0].authorizer_result_ttl_in_seconds #=> Integer
resp.items[0].authorizer_type #=> String, one of "REQUEST", "JWT"
resp.items[0].authorizer_uri #=> String
resp.items[0].identity_source #=> Array
resp.items[0].identity_source[0] #=> String
resp.items[0].identity_validation_expression #=> String
resp.items[0].jwt_configuration.audience #=> Array
resp.items[0].jwt_configuration.audience[0] #=> String
resp.items[0].jwt_configuration.issuer #=> String
resp.items[0].name #=> String
resp.items[0].authorizer_payload_format_version #=> String
resp.items[0].enable_simple_responses #=> Boolean
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetAuthorizersResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Authorizer>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2310

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

#get_deployment(params = {}) ⇒ `Types::GetDeploymentResponse`

Gets a Deployment.

Examples:

Request syntax with placeholder values


resp = client.get_deployment({
  api_id: "__string", # required
  deployment_id: "__string", # required
})

Response structure


resp.auto_deployed #=> Boolean
resp.created_date #=> Time
resp.deployment_id #=> String
resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
resp.deployment_status_message #=> String
resp.description #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:deployment_id (required, String)

Returns:

(Types::GetDeploymentResponse) —
Returns a response object which responds to the following methods:
- #auto_deployed => Boolean
- #created_date => Time
- #deployment_id => String
- #deployment_status => String
- #deployment_status_message => String
- #description => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2348

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

#get_deployments(params = {}) ⇒ `Types::GetDeploymentsResponse`

Gets the Deployments for an API.

Examples:

Request syntax with placeholder values


resp = client.get_deployments({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].auto_deployed #=> Boolean
resp.items[0].created_date #=> Time
resp.items[0].deployment_id #=> String
resp.items[0].deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
resp.items[0].deployment_status_message #=> String
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetDeploymentsResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Deployment>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2387

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

#get_domain_name(params = {}) ⇒ `Types::GetDomainNameResponse`

Gets a domain name.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_mapping_selection_expression #=> String
resp.domain_name #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> 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.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:domain_name (required, String)

Returns:

(Types::GetDomainNameResponse) —
Returns a response object which responds to the following methods:
- #api_mapping_selection_expression => String
- #domain_name => String
- #domain_name_configurations => Array<Types::DomainNameConfiguration>
- #mutual_tls_authentication => Types::MutualTlsAuthentication
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2434

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

#get_domain_names(params = {}) ⇒ `Types::GetDomainNamesResponse`

Gets the domain names for an AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_domain_names({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].api_mapping_selection_expression #=> String
resp.items[0].domain_name #=> String
resp.items[0].domain_name_configurations #=> Array
resp.items[0].domain_name_configurations[0].api_gateway_domain_name #=> String
resp.items[0].domain_name_configurations[0].certificate_arn #=> String
resp.items[0].domain_name_configurations[0].certificate_name #=> String
resp.items[0].domain_name_configurations[0].certificate_upload_date #=> Time
resp.items[0].domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.items[0].domain_name_configurations[0].domain_name_status_message #=> String
resp.items[0].domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.items[0].domain_name_configurations[0].hosted_zone_id #=> String
resp.items[0].domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.items[0].domain_name_configurations[0].ownership_verification_certificate_arn #=> 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].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:max_results (String)
:next_token (String)

Returns:

(Types::GetDomainNamesResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::DomainName>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2483

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

#get_integration(params = {}) ⇒ `Types::GetIntegrationResult`

Gets an Integration.

Examples:

Request syntax with placeholder values


resp = client.get_integration({
  api_id: "__string", # required
  integration_id: "__string", # required
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.connection_id #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.credentials_arn #=> String
resp.description #=> String
resp.integration_id #=> String
resp.integration_method #=> String
resp.integration_response_selection_expression #=> String
resp.integration_subtype #=> String
resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.integration_uri #=> String
resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
resp.payload_format_version #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> Hash
resp.response_parameters["__string"]["__string"] #=> String
resp.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer
resp.tls_config.server_name_to_verify #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:integration_id (required, String)

Returns:

(Types::GetIntegrationResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #connection_id => String
- #connection_type => String
- #content_handling_strategy => String
- #credentials_arn => String
- #description => String
- #integration_id => String
- #integration_method => String
- #integration_response_selection_expression => String
- #integration_subtype => String
- #integration_type => String
- #integration_uri => String
- #passthrough_behavior => String
- #payload_format_version => String
- #request_parameters => Hash<String,String>
- #response_parameters => Hash<String,Hash<String,String>>
- #request_templates => Hash<String,String>
- #template_selection_expression => String
- #timeout_in_millis => Integer
- #tls_config => Types::TlsConfig

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2553

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

#get_integration_response(params = {}) ⇒ `Types::GetIntegrationResponseResponse`

Gets an IntegrationResponses.

Examples:

Request syntax with placeholder values


resp = client.get_integration_response({
  api_id: "__string", # required
  integration_id: "__string", # required
  integration_response_id: "__string", # required
})

Response structure


resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.integration_response_id #=> String
resp.integration_response_key #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> String
resp.response_templates #=> Hash
resp.response_templates["__string"] #=> String
resp.template_selection_expression #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:integration_id (required, String)
:integration_response_id (required, String)

Returns:

(Types::GetIntegrationResponseResponse) —
Returns a response object which responds to the following methods:
- #content_handling_strategy => String
- #integration_response_id => String
- #integration_response_key => String
- #response_parameters => Hash<String,String>
- #response_templates => Hash<String,String>
- #template_selection_expression => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2596

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

#get_integration_responses(params = {}) ⇒ `Types::GetIntegrationResponsesResponse`

Gets the IntegrationResponses for an Integration.

Examples:

Request syntax with placeholder values


resp = client.get_integration_responses({
  api_id: "__string", # required
  integration_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.items[0].integration_response_id #=> String
resp.items[0].integration_response_key #=> 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].template_selection_expression #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:integration_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetIntegrationResponsesResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::IntegrationResponse>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2640

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

#get_integrations(params = {}) ⇒ `Types::GetIntegrationsResponse`

Gets the Integrations for an API.

Examples:

Request syntax with placeholder values


resp = client.get_integrations({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].api_gateway_managed #=> Boolean
resp.items[0].connection_id #=> String
resp.items[0].connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.items[0].content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.items[0].credentials_arn #=> String
resp.items[0].description #=> String
resp.items[0].integration_id #=> String
resp.items[0].integration_method #=> String
resp.items[0].integration_response_selection_expression #=> String
resp.items[0].integration_subtype #=> String
resp.items[0].integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.items[0].integration_uri #=> String
resp.items[0].passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
resp.items[0].payload_format_version #=> String
resp.items[0].request_parameters #=> Hash
resp.items[0].request_parameters["__string"] #=> String
resp.items[0].response_parameters #=> Hash
resp.items[0].response_parameters["__string"] #=> Hash
resp.items[0].response_parameters["__string"]["__string"] #=> String
resp.items[0].request_templates #=> Hash
resp.items[0].request_templates["__string"] #=> String
resp.items[0].template_selection_expression #=> String
resp.items[0].timeout_in_millis #=> Integer
resp.items[0].tls_config.server_name_to_verify #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetIntegrationsResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Integration>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2697

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

#get_model(params = {}) ⇒ `Types::GetModelResponse`

Gets a Model.

Examples:

Request syntax with placeholder values


resp = client.get_model({
  api_id: "__string", # required
  model_id: "__string", # required
})

Response structure


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

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:model_id (required, String)

Returns:

(Types::GetModelResponse) —
Returns a response object which responds to the following methods:
- #content_type => String
- #description => String
- #model_id => String
- #name => String
- #schema => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2733

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

#get_model_template(params = {}) ⇒ `Types::GetModelTemplateResponse`

Gets a model template.

Examples:

Request syntax with placeholder values


resp = client.get_model_template({
  api_id: "__string", # required
  model_id: "__string", # required
})

Response structure


resp.value #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:model_id (required, String)

Returns:

(Types::GetModelTemplateResponse) —
Returns a response object which responds to the following methods:
- #value => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2761

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

#get_models(params = {}) ⇒ `Types::GetModelsResponse`

Gets the Models for an API.

Examples:

Request syntax with placeholder values


resp = client.get_models({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].content_type #=> String
resp.items[0].description #=> String
resp.items[0].model_id #=> String
resp.items[0].name #=> String
resp.items[0].schema #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetModelsResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Model>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2799

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

#get_route(params = {}) ⇒ `Types::GetRouteResult`

Gets a Route.

Examples:

Request syntax with placeholder values


resp = client.get_route({
  api_id: "__string", # required
  route_id: "__string", # required
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.api_key_required #=> Boolean
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String
resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
resp.authorizer_id #=> String
resp.model_selection_expression #=> String
resp.operation_name #=> String
resp.request_models #=> Hash
resp.request_models["__string"] #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"].required #=> Boolean
resp.route_id #=> String
resp.route_key #=> String
resp.route_response_selection_expression #=> String
resp.target #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:route_id (required, String)

Returns:

(Types::GetRouteResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #api_key_required => Boolean
- #authorization_scopes => Array<String>
- #authorization_type => String
- #authorizer_id => String
- #model_selection_expression => String
- #operation_name => String
- #request_models => Hash<String,String>
- #request_parameters => Hash<String,Types::ParameterConstraints>
- #route_id => String
- #route_key => String
- #route_response_selection_expression => String
- #target => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2854

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

#get_route_response(params = {}) ⇒ `Types::GetRouteResponseResponse`

Gets a RouteResponse.

Examples:

Request syntax with placeholder values


resp = client.get_route_response({
  api_id: "__string", # required
  route_id: "__string", # required
  route_response_id: "__string", # required
})

Response structure


resp.model_selection_expression #=> String
resp.response_models #=> Hash
resp.response_models["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"].required #=> Boolean
resp.route_response_id #=> String
resp.route_response_key #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:route_id (required, String)
:route_response_id (required, String)

Returns:

(Types::GetRouteResponseResponse) —
Returns a response object which responds to the following methods:
- #model_selection_expression => String
- #response_models => Hash<String,String>
- #response_parameters => Hash<String,Types::ParameterConstraints>
- #route_response_id => String
- #route_response_key => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2895

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

#get_route_responses(params = {}) ⇒ `Types::GetRouteResponsesResponse`

Gets the RouteResponses for a Route.

Examples:

Request syntax with placeholder values


resp = client.get_route_responses({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
  route_id: "__string", # required
})

Response structure


resp.items #=> Array
resp.items[0].model_selection_expression #=> String
resp.items[0].response_models #=> Hash
resp.items[0].response_models["__string"] #=> String
resp.items[0].response_parameters #=> Hash
resp.items[0].response_parameters["__string"].required #=> Boolean
resp.items[0].route_response_id #=> String
resp.items[0].route_response_key #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)
:route_id (required, String)

Returns:

(Types::GetRouteResponsesResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::RouteResponse>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2938

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

#get_routes(params = {}) ⇒ `Types::GetRoutesResponse`

Gets the Routes for an API.

Examples:

Request syntax with placeholder values


resp = client.get_routes({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].api_gateway_managed #=> Boolean
resp.items[0].api_key_required #=> Boolean
resp.items[0].authorization_scopes #=> Array
resp.items[0].authorization_scopes[0] #=> String
resp.items[0].authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
resp.items[0].authorizer_id #=> String
resp.items[0].model_selection_expression #=> String
resp.items[0].operation_name #=> String
resp.items[0].request_models #=> Hash
resp.items[0].request_models["__string"] #=> String
resp.items[0].request_parameters #=> Hash
resp.items[0].request_parameters["__string"].required #=> Boolean
resp.items[0].route_id #=> String
resp.items[0].route_key #=> String
resp.items[0].route_response_selection_expression #=> String
resp.items[0].target #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetRoutesResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Route>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2987

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

#get_stage(params = {}) ⇒ `Types::GetStageResponse`

Gets a Stage.

Examples:

Request syntax with placeholder values


resp = client.get_stage({
  api_id: "__string", # required
  stage_name: "__string", # required
})

Response structure


resp.access_log_settings.destination_arn #=> String
resp.access_log_settings.format #=> String
resp.api_gateway_managed #=> Boolean
resp.auto_deploy #=> Boolean
resp.client_certificate_id #=> String
resp.created_date #=> Time
resp.default_route_settings.data_trace_enabled #=> Boolean
resp.default_route_settings.detailed_metrics_enabled #=> Boolean
resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.default_route_settings.throttling_burst_limit #=> Integer
resp.default_route_settings.throttling_rate_limit #=> Float
resp.deployment_id #=> String
resp.description #=> String
resp.last_deployment_status_message #=> String
resp.last_updated_date #=> Time
resp.route_settings #=> Hash
resp.route_settings["__string"].data_trace_enabled #=> Boolean
resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.route_settings["__string"].throttling_burst_limit #=> Integer
resp.route_settings["__string"].throttling_rate_limit #=> Float
resp.stage_name #=> String
resp.stage_variables #=> Hash
resp.stage_variables["__string"] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:stage_name (required, String)

Returns:

(Types::GetStageResponse) —
Returns a response object which responds to the following methods:
- #access_log_settings => Types::AccessLogSettings
- #api_gateway_managed => Boolean
- #auto_deploy => Boolean
- #client_certificate_id => String
- #created_date => Time
- #default_route_settings => Types::RouteSettings
- #deployment_id => String
- #description => String
- #last_deployment_status_message => String
- #last_updated_date => Time
- #route_settings => Hash<String,Types::RouteSettings>
- #stage_name => String
- #stage_variables => Hash<String,String>
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3053

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

#get_stages(params = {}) ⇒ `Types::GetStagesResponse`

Gets the Stages for an API.

Examples:

Request syntax with placeholder values


resp = client.get_stages({
  api_id: "__string", # required
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].access_log_settings.destination_arn #=> String
resp.items[0].access_log_settings.format #=> String
resp.items[0].api_gateway_managed #=> Boolean
resp.items[0].auto_deploy #=> Boolean
resp.items[0].client_certificate_id #=> String
resp.items[0].created_date #=> Time
resp.items[0].default_route_settings.data_trace_enabled #=> Boolean
resp.items[0].default_route_settings.detailed_metrics_enabled #=> Boolean
resp.items[0].default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.items[0].default_route_settings.throttling_burst_limit #=> Integer
resp.items[0].default_route_settings.throttling_rate_limit #=> Float
resp.items[0].deployment_id #=> String
resp.items[0].description #=> String
resp.items[0].last_deployment_status_message #=> String
resp.items[0].last_updated_date #=> Time
resp.items[0].route_settings #=> Hash
resp.items[0].route_settings["__string"].data_trace_enabled #=> Boolean
resp.items[0].route_settings["__string"].detailed_metrics_enabled #=> Boolean
resp.items[0].route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.items[0].route_settings["__string"].throttling_burst_limit #=> Integer
resp.items[0].route_settings["__string"].throttling_rate_limit #=> Float
resp.items[0].stage_name #=> String
resp.items[0].stage_variables #=> Hash
resp.items[0].stage_variables["__string"] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:max_results (String)
:next_token (String)

Returns:

(Types::GetStagesResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::Stage>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3112

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

#get_tags(params = {}) ⇒ `Types::GetTagsResponse`

Gets a collection of Tag resources.

Examples:

Request syntax with placeholder values


resp = client.get_tags({
  resource_arn: "__string", # required
})

Response structure


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

Parameters:

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

({})

Options Hash (params):

:resource_arn (required, String)

Returns:

(Types::GetTagsResponse) —
Returns a response object which responds to the following methods:
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3138

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

#get_vpc_link(params = {}) ⇒ `Types::GetVpcLinkResponse`

Gets a VPC link.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_date #=> Time
resp.name #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vpc_link_id #=> String
resp.vpc_link_status #=> String, one of "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE"
resp.vpc_link_status_message #=> String
resp.vpc_link_version #=> String, one of "V2"

Parameters:

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

({})

Options Hash (params):

:vpc_link_id (required, String)

Returns:

(Types::GetVpcLinkResponse) —
Returns a response object which responds to the following methods:
- #created_date => Time
- #name => String
- #security_group_ids => Array<String>
- #subnet_ids => Array<String>
- #tags => Hash<String,String>
- #vpc_link_id => String
- #vpc_link_status => String
- #vpc_link_status_message => String
- #vpc_link_version => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3182

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

#get_vpc_links(params = {}) ⇒ `Types::GetVpcLinksResponse`

Gets a collection of VPC links.

Examples:

Request syntax with placeholder values


resp = client.get_vpc_links({
  max_results: "__string",
  next_token: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].created_date #=> Time
resp.items[0].name #=> String
resp.items[0].security_group_ids #=> Array
resp.items[0].security_group_ids[0] #=> String
resp.items[0].subnet_ids #=> Array
resp.items[0].subnet_ids[0] #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.items[0].vpc_link_id #=> String
resp.items[0].vpc_link_status #=> String, one of "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE"
resp.items[0].vpc_link_status_message #=> String
resp.items[0].vpc_link_version #=> String, one of "V2"
resp.next_token #=> String

Parameters:

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

({})

Options Hash (params):

:max_results (String)
:next_token (String)

Returns:

(Types::GetVpcLinksResponse) —
Returns a response object which responds to the following methods:
- #items => Array<Types::VpcLink>
- #next_token => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3224

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

#import_api(params = {}) ⇒ `Types::ImportApiResponse`

Imports an API.

Examples:

Request syntax with placeholder values


resp = client.import_api({
  basepath: "__string",
  body: "__string", # required
  fail_on_warnings: false,
})

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.name #=> String
resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.route_selection_expression #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

({})

Options Hash (params):

:basepath (String)
:body (required, String)
:fail_on_warnings (Boolean)

Returns:

(Types::ImportApiResponse) —
Returns a response object which responds to the following methods:
- #api_endpoint => String
- #api_gateway_managed => Boolean
- #api_id => String
- #api_key_selection_expression => String
- #cors_configuration => Types::Cors
- #created_date => Time
- #description => String
- #disable_schema_validation => Boolean
- #disable_execute_api_endpoint => Boolean
- #import_info => Array<String>
- #name => String
- #protocol_type => String
- #route_selection_expression => String
- #tags => Hash<String,String>
- #version => String
- #warnings => Array<String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3297

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

#reimport_api(params = {}) ⇒ `Types::ReimportApiResponse`

Puts an Api resource.

Examples:

Request syntax with placeholder values


resp = client.reimport_api({
  api_id: "__string", # required
  basepath: "__string",
  body: "__string", # required
  fail_on_warnings: false,
})

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.name #=> String
resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.route_selection_expression #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:basepath (String)
:body (required, String)
:fail_on_warnings (Boolean)

Returns:

(Types::ReimportApiResponse) —
Returns a response object which responds to the following methods:
- #api_endpoint => String
- #api_gateway_managed => Boolean
- #api_id => String
- #api_key_selection_expression => String
- #cors_configuration => Types::Cors
- #created_date => Time
- #description => String
- #disable_schema_validation => Boolean
- #disable_execute_api_endpoint => Boolean
- #import_info => Array<String>
- #name => String
- #protocol_type => String
- #route_selection_expression => String
- #tags => Hash<String,String>
- #version => String
- #warnings => Array<String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3373

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

#reset_authorizers_cache(params = {}) ⇒ `Struct`

Resets all authorizer cache entries for the specified stage. Supported only for HTTP API Lambda authorizers.

Examples:

Request syntax with placeholder values


resp = client.reset_authorizers_cache({
  api_id: "__string", # required
  stage_name: "__string", # required
})

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:stage_name (required, String)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2016

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

#tag_resource(params = {}) ⇒ `Struct`

Creates a new Tag resource to represent a tag.

Examples:

Request syntax with placeholder values


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

Parameters:

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

({})

Options Hash (params):

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

Represents a collection of tags associated with the resource.

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3398

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

#untag_resource(params = {}) ⇒ `Struct`

Deletes a Tag.

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)
:tag_keys (required, Array<String>)

Returns:

(Struct) —

Returns an empty response.

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3420

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

#update_api(params = {}) ⇒ `Types::UpdateApiResponse`

Updates an Api resource.

Examples:

Request syntax with placeholder values


resp = client.update_api({
  api_id: "__string", # required
  api_key_selection_expression: "SelectionExpression",
  cors_configuration: {
    allow_credentials: false,
    allow_headers: ["__string"],
    allow_methods: ["StringWithLengthBetween1And64"],
    allow_origins: ["__string"],
    expose_headers: ["__string"],
    max_age: 1,
  },
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  disable_schema_validation: false,
  disable_execute_api_endpoint: false,
  name: "StringWithLengthBetween1And128",
  route_key: "SelectionKey",
  route_selection_expression: "SelectionExpression",
  target: "UriWithLengthBetween1And2048",
  version: "StringWithLengthBetween1And64",
})

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.name #=> String
resp.protocol_type #=> String, one of "WEBSOCKET", "HTTP"
resp.route_selection_expression #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:api_key_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:cors_configuration (Types::Cors) —

Represents a CORS configuration. Supported only for HTTP APIs. See

Configuring CORS][1

for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html
:credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:description (String) —

A string with a length between [0-1024].
:disable_schema_validation (Boolean)
:disable_execute_api_endpoint (Boolean)
:name (String) —

A string with a length between [1-128].
:route_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:route_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:target (String) —

A string representation of a URI with a length between [1-2048].
:version (String) —

A string with a length between [1-64].

Returns:

(Types::UpdateApiResponse) —
Returns a response object which responds to the following methods:
- #api_endpoint => String
- #api_gateway_managed => Boolean
- #api_id => String
- #api_key_selection_expression => String
- #cors_configuration => Types::Cors
- #created_date => Time
- #description => String
- #disable_schema_validation => Boolean
- #disable_execute_api_endpoint => Boolean
- #import_info => Array<String>
- #name => String
- #protocol_type => String
- #route_selection_expression => String
- #tags => Hash<String,String>
- #version => String
- #warnings => Array<String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3558

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

#update_api_mapping(params = {}) ⇒ `Types::UpdateApiMappingResponse`

The API mapping.

Examples:

Request syntax with placeholder values


resp = client.update_api_mapping({
  api_id: "Id", # required
  api_mapping_id: "__string", # required
  api_mapping_key: "SelectionKey",
  domain_name: "__string", # required
  stage: "StringWithLengthBetween1And128",
})

Response structure


resp.api_id #=> String
resp.api_mapping_id #=> String
resp.api_mapping_key #=> String
resp.stage #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String) —

The identifier.
:api_mapping_id (required, String)
:api_mapping_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:domain_name (required, String)
:stage (String) —

A string with a length between [1-128].

Returns:

(Types::UpdateApiMappingResponse) —
Returns a response object which responds to the following methods:
- #api_id => String
- #api_mapping_id => String
- #api_mapping_key => String
- #stage => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3611

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

#update_authorizer(params = {}) ⇒ `Types::UpdateAuthorizerResponse`

Updates an Authorizer.

Examples:

Request syntax with placeholder values


resp = client.update_authorizer({
  api_id: "__string", # required
  authorizer_credentials_arn: "Arn",
  authorizer_id: "__string", # required
  authorizer_result_ttl_in_seconds: 1,
  authorizer_type: "REQUEST", # accepts REQUEST, JWT
  authorizer_uri: "UriWithLengthBetween1And2048",
  identity_source: ["__string"],
  identity_validation_expression: "StringWithLengthBetween0And1024",
  jwt_configuration: {
    audience: ["__string"],
    issuer: "UriWithLengthBetween1And2048",
  },
  name: "StringWithLengthBetween1And128",
  authorizer_payload_format_version: "StringWithLengthBetween1And64",
  enable_simple_responses: false,
})

Response structure


resp.authorizer_credentials_arn #=> String
resp.authorizer_id #=> String
resp.authorizer_result_ttl_in_seconds #=> Integer
resp.authorizer_type #=> String, one of "REQUEST", "JWT"
resp.authorizer_uri #=> String
resp.identity_source #=> Array
resp.identity_source[0] #=> String
resp.identity_validation_expression #=> String
resp.jwt_configuration.audience #=> Array
resp.jwt_configuration.audience[0] #=> String
resp.jwt_configuration.issuer #=> String
resp.name #=> String
resp.authorizer_payload_format_version #=> String
resp.enable_simple_responses #=> Boolean

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:authorizer_credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:authorizer_id (required, String)
:authorizer_result_ttl_in_seconds (Integer) —

An integer with a value between [0-3600].
:authorizer_type (String) —

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
:authorizer_uri (String) —

A string representation of a URI with a length between [1-2048].
:identity_source (Array<String>) —

The identity source for which authorization is requested. 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 string with a length between [0-1024].
:jwt_configuration (Types::JWTConfiguration) —

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
:name (String) —

A string with a length between [1-128].
:authorizer_payload_format_version (String) —

A string with a length between [1-64].
:enable_simple_responses (Boolean)

Returns:

(Types::UpdateAuthorizerResponse) —
Returns a response object which responds to the following methods:
- #authorizer_credentials_arn => String
- #authorizer_id => String
- #authorizer_result_ttl_in_seconds => Integer
- #authorizer_type => String
- #authorizer_uri => String
- #identity_source => Array<String>
- #identity_validation_expression => String
- #jwt_configuration => Types::JWTConfiguration
- #name => String
- #authorizer_payload_format_version => String
- #enable_simple_responses => Boolean

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3721

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

#update_deployment(params = {}) ⇒ `Types::UpdateDeploymentResponse`

Updates a Deployment.

Examples:

Request syntax with placeholder values


resp = client.update_deployment({
  api_id: "__string", # required
  deployment_id: "__string", # required
  description: "StringWithLengthBetween0And1024",
})

Response structure


resp.auto_deployed #=> Boolean
resp.created_date #=> Time
resp.deployment_id #=> String
resp.deployment_status #=> String, one of "PENDING", "FAILED", "DEPLOYED"
resp.deployment_status_message #=> String
resp.description #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:deployment_id (required, String)
:description (String) —

A string with a length between [0-1024].

Returns:

(Types::UpdateDeploymentResponse) —
Returns a response object which responds to the following methods:
- #auto_deployed => Boolean
- #created_date => Time
- #deployment_id => String
- #deployment_status => String
- #deployment_status_message => String
- #description => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3763

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

#update_domain_name(params = {}) ⇒ `Types::UpdateDomainNameResponse`

Updates a domain name.

Examples:

Request syntax with placeholder values


resp = client.update_domain_name({
  domain_name: "__string", # required
  domain_name_configurations: [
    {
      api_gateway_domain_name: "__string",
      certificate_arn: "Arn",
      certificate_name: "StringWithLengthBetween1And128",
      certificate_upload_date: Time.now,
      domain_name_status: "AVAILABLE", # accepts AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, PENDING_OWNERSHIP_VERIFICATION
      domain_name_status_message: "__string",
      endpoint_type: "REGIONAL", # accepts REGIONAL, EDGE
      hosted_zone_id: "__string",
      security_policy: "TLS_1_0", # accepts TLS_1_0, TLS_1_2
      ownership_verification_certificate_arn: "Arn",
    },
  ],
  mutual_tls_authentication: {
    truststore_uri: "UriWithLengthBetween1And2048",
    truststore_version: "StringWithLengthBetween1And64",
  },
})

Response structure


resp.api_mapping_selection_expression #=> String
resp.domain_name #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> 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.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:domain_name (required, String)
:domain_name_configurations (Array<Types::DomainNameConfiguration>) —

The domain name configurations.
:mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

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

Returns:

(Types::UpdateDomainNameResponse) —
Returns a response object which responds to the following methods:
- #api_mapping_selection_expression => String
- #domain_name => String
- #domain_name_configurations => Array<Types::DomainNameConfiguration>
- #mutual_tls_authentication => Types::MutualTlsAuthentication
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3836

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

#update_integration(params = {}) ⇒ `Types::UpdateIntegrationResult`

Updates an Integration.

Examples:

Request syntax with placeholder values


resp = client.update_integration({
  api_id: "__string", # required
  connection_id: "StringWithLengthBetween1And1024",
  connection_type: "INTERNET", # accepts INTERNET, VPC_LINK
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  credentials_arn: "Arn",
  description: "StringWithLengthBetween0And1024",
  integration_id: "__string", # required
  integration_method: "StringWithLengthBetween1And64",
  integration_subtype: "StringWithLengthBetween1And128",
  integration_type: "AWS", # accepts AWS, HTTP, MOCK, HTTP_PROXY, AWS_PROXY
  integration_uri: "UriWithLengthBetween1And2048",
  passthrough_behavior: "WHEN_NO_MATCH", # accepts WHEN_NO_MATCH, NEVER, WHEN_NO_TEMPLATES
  payload_format_version: "StringWithLengthBetween1And64",
  request_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_parameters: {
    "__string" => {
      "__string" => "StringWithLengthBetween1And512",
    },
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
  tls_config: {
    server_name_to_verify: "StringWithLengthBetween1And512",
  },
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.connection_id #=> String
resp.connection_type #=> String, one of "INTERNET", "VPC_LINK"
resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.credentials_arn #=> String
resp.description #=> String
resp.integration_id #=> String
resp.integration_method #=> String
resp.integration_response_selection_expression #=> String
resp.integration_subtype #=> String
resp.integration_type #=> String, one of "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY"
resp.integration_uri #=> String
resp.passthrough_behavior #=> String, one of "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES"
resp.payload_format_version #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> Hash
resp.response_parameters["__string"]["__string"] #=> String
resp.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer
resp.tls_config.server_name_to_verify #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:connection_id (String) —

A string with a length between [1-1024].
:connection_type (String) —

Represents a connection type.
:content_handling_strategy (String) —

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
:credentials_arn (String) —

Represents an Amazon Resource Name (ARN).
:description (String) —

A string with a length between [0-1024].
:integration_id (required, String)
:integration_method (String) —

A string with a length between [1-64].
:integration_subtype (String) —

A string with a length between [1-128].
:integration_type (String) —

Represents an API method integration type.
:integration_uri (String) —

A string representation of a URI with a length between [1-2048].
:passthrough_behavior (String) —

Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
:payload_format_version (String) —

A string with a length between [1-64].
:request_parameters (Hash<String,String>) —

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs].

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
:response_parameters (Hash<String,Hash>) —

Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.
:request_templates (Hash<String,String>) —

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
:template_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:timeout_in_millis (Integer) —

An integer with a value between [50-30000].
:tls_config (Types::TlsConfigInput) —

The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

Returns:

(Types::UpdateIntegrationResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #connection_id => String
- #connection_type => String
- #content_handling_strategy => String
- #credentials_arn => String
- #description => String
- #integration_id => String
- #integration_method => String
- #integration_response_selection_expression => String
- #integration_subtype => String
- #integration_type => String
- #integration_uri => String
- #passthrough_behavior => String
- #payload_format_version => String
- #request_parameters => Hash<String,String>
- #response_parameters => Hash<String,Hash<String,String>>
- #request_templates => Hash<String,String>
- #template_selection_expression => String
- #timeout_in_millis => Integer
- #tls_config => Types::TlsConfig

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4027

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

#update_integration_response(params = {}) ⇒ `Types::UpdateIntegrationResponseResponse`

Updates an IntegrationResponses.

Examples:

Request syntax with placeholder values


resp = client.update_integration_response({
  api_id: "__string", # required
  content_handling_strategy: "CONVERT_TO_BINARY", # accepts CONVERT_TO_BINARY, CONVERT_TO_TEXT
  integration_id: "__string", # required
  integration_response_id: "__string", # required
  integration_response_key: "SelectionKey",
  response_parameters: {
    "__string" => "StringWithLengthBetween1And512",
  },
  response_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
})

Response structure


resp.content_handling_strategy #=> String, one of "CONVERT_TO_BINARY", "CONVERT_TO_TEXT"
resp.integration_response_id #=> String
resp.integration_response_key #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"] #=> String
resp.response_templates #=> Hash
resp.response_templates["__string"] #=> String
resp.template_selection_expression #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:content_handling_strategy (String) —

Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
:integration_id (required, String)
:integration_response_id (required, String)
:integration_response_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:response_parameters (Hash<String,String>) —

For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. 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 backend. 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.

For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Working with AWS service integrations for HTTP APIs].

For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see [Transforming API requests and responses].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html
:response_templates (Hash<String,String>) —

A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.
:template_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(Types::UpdateIntegrationResponseResponse) —
Returns a response object which responds to the following methods:
- #content_handling_strategy => String
- #integration_response_id => String
- #integration_response_key => String
- #response_parameters => Hash<String,String>
- #response_templates => Hash<String,String>
- #template_selection_expression => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4139

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

#update_model(params = {}) ⇒ `Types::UpdateModelResponse`

Updates a Model.

Examples:

Request syntax with placeholder values


resp = client.update_model({
  api_id: "__string", # required
  content_type: "StringWithLengthBetween1And256",
  description: "StringWithLengthBetween0And1024",
  model_id: "__string", # required
  name: "StringWithLengthBetween1And128",
  schema: "StringWithLengthBetween0And32K",
})

Response structure


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

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:content_type (String) —

A string with a length between [1-256].
:description (String) —

A string with a length between [0-1024].
:model_id (required, String)
:name (String) —

A string with a length between [1-128].
:schema (String) —

A string with a length between [0-32768].

Returns:

(Types::UpdateModelResponse) —
Returns a response object which responds to the following methods:
- #content_type => String
- #description => String
- #model_id => String
- #name => String
- #schema => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4191

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

#update_route(params = {}) ⇒ `Types::UpdateRouteResult`

Updates a Route.

Examples:

Request syntax with placeholder values


resp = client.update_route({
  api_id: "__string", # required
  api_key_required: false,
  authorization_scopes: ["StringWithLengthBetween1And64"],
  authorization_type: "NONE", # accepts NONE, AWS_IAM, CUSTOM, JWT
  authorizer_id: "Id",
  model_selection_expression: "SelectionExpression",
  operation_name: "StringWithLengthBetween1And64",
  request_models: {
    "__string" => "StringWithLengthBetween1And128",
  },
  request_parameters: {
    "__string" => {
      required: false,
    },
  },
  route_id: "__string", # required
  route_key: "SelectionKey",
  route_response_selection_expression: "SelectionExpression",
  target: "StringWithLengthBetween1And128",
})

Response structure


resp.api_gateway_managed #=> Boolean
resp.api_key_required #=> Boolean
resp.authorization_scopes #=> Array
resp.authorization_scopes[0] #=> String
resp.authorization_type #=> String, one of "NONE", "AWS_IAM", "CUSTOM", "JWT"
resp.authorizer_id #=> String
resp.model_selection_expression #=> String
resp.operation_name #=> String
resp.request_models #=> Hash
resp.request_models["__string"] #=> String
resp.request_parameters #=> Hash
resp.request_parameters["__string"].required #=> Boolean
resp.route_id #=> String
resp.route_key #=> String
resp.route_response_selection_expression #=> String
resp.target #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:api_key_required (Boolean)
:authorization_scopes (Array<String>) —

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

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
:authorizer_id (String) —

The identifier.
:model_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:operation_name (String) —

A string with a length between [1-64].
:request_models (Hash<String,String>) —

The route models.
:request_parameters (Hash<String,Types::ParameterConstraints>) —

The route parameters.
:route_id (required, String)
:route_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:route_response_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:target (String) —

A string with a length between [1-128].

Returns:

(Types::UpdateRouteResult) —
Returns a response object which responds to the following methods:
- #api_gateway_managed => Boolean
- #api_key_required => Boolean
- #authorization_scopes => Array<String>
- #authorization_type => String
- #authorizer_id => String
- #model_selection_expression => String
- #operation_name => String
- #request_models => Hash<String,String>
- #request_parameters => Hash<String,Types::ParameterConstraints>
- #route_id => String
- #route_key => String
- #route_response_selection_expression => String
- #target => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4323

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

#update_route_response(params = {}) ⇒ `Types::UpdateRouteResponseResponse`

Updates a RouteResponse.

Examples:

Request syntax with placeholder values


resp = client.update_route_response({
  api_id: "__string", # required
  model_selection_expression: "SelectionExpression",
  response_models: {
    "__string" => "StringWithLengthBetween1And128",
  },
  response_parameters: {
    "__string" => {
      required: false,
    },
  },
  route_id: "__string", # required
  route_response_id: "__string", # required
  route_response_key: "SelectionKey",
})

Response structure


resp.model_selection_expression #=> String
resp.response_models #=> Hash
resp.response_models["__string"] #=> String
resp.response_parameters #=> Hash
resp.response_parameters["__string"].required #=> Boolean
resp.route_response_id #=> String
resp.route_response_key #=> String

Parameters:

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

({})

Options Hash (params):

:api_id (required, String)
:model_selection_expression (String) —

An expression used to extract information at runtime. See [Selection Expressions] for more information.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions
:response_models (Hash<String,String>) —

The route models.
:response_parameters (Hash<String,Types::ParameterConstraints>) —

The route parameters.
:route_id (required, String)
:route_response_id (required, String)
:route_response_key (String) —

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See

Selection Expressions][1

for a list of expressions and each

expression’s associated selection key type.

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions

Returns:

(Types::UpdateRouteResponseResponse) —
Returns a response object which responds to the following methods:
- #model_selection_expression => String
- #response_models => Hash<String,String>
- #response_parameters => Hash<String,Types::ParameterConstraints>
- #route_response_id => String
- #route_response_key => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4398

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

#update_stage(params = {}) ⇒ `Types::UpdateStageResponse`

Updates a Stage.

Examples:

Request syntax with placeholder values


resp = client.update_stage({
  access_log_settings: {
    destination_arn: "Arn",
    format: "StringWithLengthBetween1And1024",
  },
  api_id: "__string", # required
  auto_deploy: false,
  client_certificate_id: "Id",
  default_route_settings: {
    data_trace_enabled: false,
    detailed_metrics_enabled: false,
    logging_level: "ERROR", # accepts ERROR, INFO, OFF
    throttling_burst_limit: 1,
    throttling_rate_limit: 1.0,
  },
  deployment_id: "Id",
  description: "StringWithLengthBetween0And1024",
  route_settings: {
    "__string" => {
      data_trace_enabled: false,
      detailed_metrics_enabled: false,
      logging_level: "ERROR", # accepts ERROR, INFO, OFF
      throttling_burst_limit: 1,
      throttling_rate_limit: 1.0,
    },
  },
  stage_name: "__string", # required
  stage_variables: {
    "__string" => "StringWithLengthBetween0And2048",
  },
})

Response structure


resp.access_log_settings.destination_arn #=> String
resp.access_log_settings.format #=> String
resp.api_gateway_managed #=> Boolean
resp.auto_deploy #=> Boolean
resp.client_certificate_id #=> String
resp.created_date #=> Time
resp.default_route_settings.data_trace_enabled #=> Boolean
resp.default_route_settings.detailed_metrics_enabled #=> Boolean
resp.default_route_settings.logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.default_route_settings.throttling_burst_limit #=> Integer
resp.default_route_settings.throttling_rate_limit #=> Float
resp.deployment_id #=> String
resp.description #=> String
resp.last_deployment_status_message #=> String
resp.last_updated_date #=> Time
resp.route_settings #=> Hash
resp.route_settings["__string"].data_trace_enabled #=> Boolean
resp.route_settings["__string"].detailed_metrics_enabled #=> Boolean
resp.route_settings["__string"].logging_level #=> String, one of "ERROR", "INFO", "OFF"
resp.route_settings["__string"].throttling_burst_limit #=> Integer
resp.route_settings["__string"].throttling_rate_limit #=> Float
resp.stage_name #=> String
resp.stage_variables #=> Hash
resp.stage_variables["__string"] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

({})

Options Hash (params):

:access_log_settings (Types::AccessLogSettings) —

Settings for logging access in a stage.
:api_id (required, String)
:auto_deploy (Boolean)
:client_certificate_id (String) —

The identifier.
:default_route_settings (Types::RouteSettings) —

Represents a collection of route settings.
:deployment_id (String) —

The identifier.
:description (String) —

A string with a length between [0-1024].
:route_settings (Hash<String,Types::RouteSettings>) —

The route settings map.
:stage_name (required, String)
:stage_variables (Hash<String,String>) —

The stage variable map.

Returns:

(Types::UpdateStageResponse) —
Returns a response object which responds to the following methods:
- #access_log_settings => Types::AccessLogSettings
- #api_gateway_managed => Boolean
- #auto_deploy => Boolean
- #client_certificate_id => String
- #created_date => Time
- #default_route_settings => Types::RouteSettings
- #deployment_id => String
- #description => String
- #last_deployment_status_message => String
- #last_updated_date => Time
- #route_settings => Hash<String,Types::RouteSettings>
- #stage_name => String
- #stage_variables => Hash<String,String>
- #tags => Hash<String,String>

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4514

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

#update_vpc_link(params = {}) ⇒ `Types::UpdateVpcLinkResponse`

Updates a VPC link.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_link({
  name: "StringWithLengthBetween1And128",
  vpc_link_id: "__string", # required
})

Response structure


resp.created_date #=> Time
resp.name #=> String
resp.security_group_ids #=> Array
resp.security_group_ids[0] #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String
resp.vpc_link_id #=> String
resp.vpc_link_status #=> String, one of "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE"
resp.vpc_link_status_message #=> String
resp.vpc_link_version #=> String, one of "V2"

Parameters:

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

({})

Options Hash (params):

:name (String) —

A string with a length between [1-128].
:vpc_link_id (required, String)

Returns:

(Types::UpdateVpcLinkResponse) —
Returns a response object which responds to the following methods:
- #created_date => Time
- #name => String
- #security_group_ids => Array<String>
- #subnet_ids => Array<String>
- #tags => Hash<String,String>
- #vpc_link_id => String
- #vpc_link_status => String
- #vpc_link_status_message => String
- #vpc_link_version => String

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4562

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

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



4591
4592
4593

# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4591

def waiter_names
  []
end

Class: Aws::ApiGatewayV2::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

#create_api(params = {}) ⇒ Types::CreateApiResponse

Examples:

Request syntax with placeholder values

Response structure

#create_api_mapping(params = {}) ⇒ Types::CreateApiMappingResponse

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#create_deployment(params = {}) ⇒ Types::CreateDeploymentResponse

Examples:

Request syntax with placeholder values

Response structure

#create_domain_name(params = {}) ⇒ Types::CreateDomainNameResponse

Examples:

Request syntax with placeholder values

Response structure

#create_integration(params = {}) ⇒ Types::CreateIntegrationResult

Examples:

Request syntax with placeholder values

Response structure

#create_integration_response(params = {}) ⇒ Types::CreateIntegrationResponseResponse

Examples:

Request syntax with placeholder values

Response structure

#create_model(params = {}) ⇒ Types::CreateModelResponse

Examples:

Request syntax with placeholder values

Response structure

#create_route(params = {}) ⇒ Types::CreateRouteResult

Examples:

Request syntax with placeholder values

Response structure

#create_route_response(params = {}) ⇒ Types::CreateRouteResponseResponse

Examples:

Request syntax with placeholder values

Response structure

#create_stage(params = {}) ⇒ Types::CreateStageResponse

Examples:

Request syntax with placeholder values

Response structure

#create_vpc_link(params = {}) ⇒ Types::CreateVpcLinkResponse

Examples:

Request syntax with placeholder values

Response structure

#delete_access_log_settings(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_api(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_api_mapping(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_authorizer(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_cors_configuration(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_deployment(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#build_request(operation_name, params = {}) ⇒ `Object`

#create_api(params = {}) ⇒ `Types::CreateApiResponse`

#create_api_mapping(params = {}) ⇒ `Types::CreateApiMappingResponse`

#create_authorizer(params = {}) ⇒ `Types::CreateAuthorizerResponse`

#create_deployment(params = {}) ⇒ `Types::CreateDeploymentResponse`

#create_domain_name(params = {}) ⇒ `Types::CreateDomainNameResponse`

#create_integration(params = {}) ⇒ `Types::CreateIntegrationResult`

#create_integration_response(params = {}) ⇒ `Types::CreateIntegrationResponseResponse`

#create_model(params = {}) ⇒ `Types::CreateModelResponse`

#create_route(params = {}) ⇒ `Types::CreateRouteResult`

#create_route_response(params = {}) ⇒ `Types::CreateRouteResponseResponse`

#create_stage(params = {}) ⇒ `Types::CreateStageResponse`

#create_vpc_link(params = {}) ⇒ `Types::CreateVpcLinkResponse`

#delete_access_log_settings(params = {}) ⇒ `Struct`

#delete_api(params = {}) ⇒ `Struct`

#delete_api_mapping(params = {}) ⇒ `Struct`

#delete_authorizer(params = {}) ⇒ `Struct`

#delete_cors_configuration(params = {}) ⇒ `Struct`

#delete_deployment(params = {}) ⇒ `Struct`

#delete_domain_name(params = {}) ⇒ `Struct`

#delete_integration(params = {}) ⇒ `Struct`

#delete_integration_response(params = {}) ⇒ `Struct`

#delete_model(params = {}) ⇒ `Struct`

#delete_route(params = {}) ⇒ `Struct`

#delete_route_request_parameter(params = {}) ⇒ `Struct`

#delete_route_response(params = {}) ⇒ `Struct`

#delete_route_settings(params = {}) ⇒ `Struct`

#delete_stage(params = {}) ⇒ `Struct`

#delete_vpc_link(params = {}) ⇒ `Struct`

#export_api(params = {}) ⇒ `Types::ExportApiResponse`

#get_api(params = {}) ⇒ `Types::GetApiResponse`

#get_api_mapping(params = {}) ⇒ `Types::GetApiMappingResponse`

#get_api_mappings(params = {}) ⇒ `Types::GetApiMappingsResponse`

#get_apis(params = {}) ⇒ `Types::GetApisResponse`

#get_authorizer(params = {}) ⇒ `Types::GetAuthorizerResponse`

#get_authorizers(params = {}) ⇒ `Types::GetAuthorizersResponse`

#get_deployment(params = {}) ⇒ `Types::GetDeploymentResponse`

#get_deployments(params = {}) ⇒ `Types::GetDeploymentsResponse`

#get_domain_name(params = {}) ⇒ `Types::GetDomainNameResponse`