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

Class: Aws::ApiGatewayV2::Client

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :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.

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

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

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

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

  • :retry_limit (Integer) — default: 3

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

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

  • :http_idle_timeout (Float) — default: 5

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

  • :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 yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

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



251
252
253
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#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,
  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_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.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.

  • :cors_configuration (Types::Cors)

    Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

  • :credentials_arn (String)

    Represents an Amazon Resource Name (ARN).

  • :description (String)

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

  • :disable_schema_validation (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 for a list of expressions and each expression's associated selection key type.

  • :route_selection_expression (String)

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

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



390
391
392
393
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 390

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 for a list of expressions and each expression's associated selection key type.

  • :domain_name (required, String)
  • :stage (required, String)

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

Returns:



440
441
442
443
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 440

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

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

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. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

Returns:



536
537
538
539
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 536

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:



579
580
581
582
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 579

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
      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
    },
  ],
  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"
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.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.

  • :tags (Hash<String,String>)

    Represents a collection of tags associated with the resource.

Returns:



643
644
645
646
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 643

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_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",
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
})

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_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.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer

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

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

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

  • :timeout_in_millis (Integer)

    An integer with a value between [50-29000].

Returns:



781
782
783
784
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 781

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 for a list of expressions and each expression's associated selection key type.

  • :response_parameters (Hash<String,String>)

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

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

Returns:



870
871
872
873
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 870

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:



919
920
921
922
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 919

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, or JWT for using JSON Web Tokens.

  • :authorizer_id (String)

    The identifier.

  • :model_selection_expression (String)

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

  • :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 for a list of expressions and each expression's associated selection key type.

  • :route_response_selection_expression (String)

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

  • :target (String)

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

Returns:



1047
1048
1049
1050
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1047

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.

  • :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 for a list of expressions and each expression's associated selection key type.

Returns:



1119
1120
1121
1122
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1119

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, false
    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, false
      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", "false"
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", "false"
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:



1242
1243
1244
1245
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1242

def create_stage(params = {}, options = {})
  req = build_request(:create_stage, 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.



1261
1262
1263
1264
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1261

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.



1283
1284
1285
1286
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1283

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.



1305
1306
1307
1308
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1305

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.



1324
1325
1326
1327
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1324

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.



1346
1347
1348
1349
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1346

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.



1365
1366
1367
1368
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1365

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.



1387
1388
1389
1390
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1387

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.



1412
1413
1414
1415
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1412

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.



1434
1435
1436
1437
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1434

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.



1456
1457
1458
1459
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1456

def delete_route(params = {}, options = {})
  req = build_request(:delete_route, 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.



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

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: "SelectionKey", # required
  stage_name: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :api_id (required, String)
  • :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 for a list of expressions and each expression's associated selection key type.

  • :stage_name (required, String)

Returns:

  • (Struct)

    Returns an empty response.



1514
1515
1516
1517
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1514

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.



1536
1537
1538
1539
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1536

def delete_stage(params = {}, options = {})
  req = build_request(:delete_stage, 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_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.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:



1599
1600
1601
1602
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1599

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:



1633
1634
1635
1636
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1633

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:



1670
1671
1672
1673
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1670

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_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].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:



1726
1727
1728
1729
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1726

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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



1773
1774
1775
1776
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1773

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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



1818
1819
1820
1821
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1818

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:



1856
1857
1858
1859
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1856

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:



1895
1896
1897
1898
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1895

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"
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.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

Returns:



1936
1937
1938
1939
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1936

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"
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].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:



1980
1981
1982
1983
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 1980

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_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.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



2042
2043
2044
2045
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2042

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:



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

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:



2129
2130
2131
2132
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2129

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_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].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.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



2181
2182
2183
2184
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2181

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:



2217
2218
2219
2220
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2217

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:



2245
2246
2247
2248
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2245

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:



2283
2284
2285
2286
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2283

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:



2338
2339
2340
2341
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2338

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:



2379
2380
2381
2382
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2379

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:



2422
2423
2424
2425
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2422

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:



2471
2472
2473
2474
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2471

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", "false"
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", "false"
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:



2537
2538
2539
2540
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2537

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", "false"
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", "false"
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:



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

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:



2622
2623
2624
2625
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2622

def get_tags(params = {}, options = {})
  req = build_request(:get_tags, 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_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.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:



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

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



2763
2764
2765
2766
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2763

def reimport_api(params = {}, options = {})
  req = build_request(:reimport_api, 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.



2788
2789
2790
2791
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2788

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.



2810
2811
2812
2813
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2810

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,
  name: "StringWithLengthBetween1And128",
  route_key: "SelectionKey",
  route_selection_expression: "SelectionExpression",
  target: "UriWithLengthBetween1And2048",
  version: "StringWithLengthBetween1And64",
})

Response structure


resp.api_endpoint #=> String
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.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.

  • :cors_configuration (Types::Cors)

    Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

  • :credentials_arn (String)

    Represents an Amazon Resource Name (ARN).

  • :description (String)

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

  • :disable_schema_validation (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 for a list of expressions and each expression's associated selection key type.

  • :route_selection_expression (String)

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

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



2941
2942
2943
2944
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2941

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 for a list of expressions and each expression's associated selection key type.

  • :domain_name (required, String)
  • :stage (String)

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

Returns:



2994
2995
2996
2997
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 2994

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",
})

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

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. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

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

Returns:



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

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:



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

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
      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
    },
  ],
})

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"
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.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:



3192
3193
3194
3195
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 3192

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_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",
  },
  request_templates: {
    "__string" => "StringWithLengthBetween0And32K",
  },
  template_selection_expression: "SelectionExpression",
  timeout_in_millis: 1,
})

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_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.request_templates #=> Hash
resp.request_templates["__string"] #=> String
resp.template_selection_expression #=> String
resp.timeout_in_millis #=> Integer

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

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

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

  • :timeout_in_millis (Integer)

    An integer with a value between [50-29000].

Returns:



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

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 for a list of expressions and each expression's associated selection key type.

  • :response_parameters (Hash<String,String>)

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

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

Returns:



3425
3426
3427
3428
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 3425

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:



3477
3478
3479
3480
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 3477

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, or JWT for using JSON Web Tokens.

  • :authorizer_id (String)

    The identifier.

  • :model_selection_expression (String)

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

  • :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 for a list of expressions and each expression's associated selection key type.

  • :route_response_selection_expression (String)

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

  • :target (String)

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

Returns:



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

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.

  • :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 for a list of expressions and each expression's associated selection key type.

Returns:



3683
3684
3685
3686
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 3683

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, false
    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, false
      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", "false"
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", "false"
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:



3799
3800
3801
3802
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/client.rb', line 3799

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