Class: Aws::ApiGatewayV2::Client

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

Overview

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

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

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

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

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

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

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

  • :region (required, String) —

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

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

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

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

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

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

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

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

  • :stub_responses (Boolean) — default: false —

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

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



471
472
473
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

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



6151
6152
6153
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6151

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

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



6154
6155
6156
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6154

def errors_module
  Errors
end

Instance Method Details

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

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

Parameters:

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


6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6124

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

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

Creates an Api resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack"
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):

Returns:



623
624
625
626
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 623

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

Returns:



673
674
675
676
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 673

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

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

Creates an Authorizer for an API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Represents an Amazon Resource Name (ARN).

  • :authorizer_result_ttl_in_seconds (Integer) —

    An integer with a value between [0-3600].

  • :authorizer_type (required, String) —

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

  • :authorizer_uri (String) —

    A string representation of a URI with a length between [1-2048].

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

    The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

  • :identity_validation_expression (String) —

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

  • :jwt_configuration (Types::JWTConfiguration) —

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • :name (required, String) —

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

  • :authorizer_payload_format_version (String) —

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

  • :enable_simple_responses (Boolean)

Returns:



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

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:



823
824
825
826
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 823

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

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

Creates a domain name.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_mapping_selection_expression #=> String
resp.domain_name #=> String
resp.domain_name_arn #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].ip_address_type #=> String, one of "ipv4", "dualstack"
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String
resp.routing_mode #=> String, one of "API_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_API_MAPPING"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

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

  • :domain_name_configurations (Array<Types::DomainNameConfiguration>) —

    The domain name configurations.

  • :mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

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

  • :routing_mode (String) —

    The routing mode API Gateway uses to route traffic to your APIs.

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

    Represents a collection of tags associated with the resource.

Returns:



913
914
915
916
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 913

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

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

Creates an Integration.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :connection_type (String) —

    Represents a connection type.

  • :content_handling_strategy (String) —

    Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

  • :credentials_arn (String) —

    Represents an Amazon Resource Name (ARN).

  • :description (String) —

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

  • :integration_method (String) —

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

  • :integration_subtype (String) —

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

  • :integration_type (required, String) —

    Represents an API method integration type.

  • :integration_uri (String) —

    A string representation of a URI with a length between [1-2048].

  • :passthrough_behavior (String) —

    Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

  • :payload_format_version (String) —

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

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

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.*location.name* , where *location* is querystring, path, or header; and *name* must be a valid and unique method request parameter name.

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

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

    [1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

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

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.

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

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

  • :template_selection_expression (String) —

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

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

  • :timeout_in_millis (Integer) —

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

  • :tls_config (Types::TlsConfigInput) —

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

Returns:



1101
1102
1103
1104
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1101

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

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

Creates an IntegrationResponses.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

  • :integration_id (required, String)
  • :integration_response_key (required, String) —

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

    Selection Expressions][1

    for a list of expressions and each

    expression’s associated selection key type.

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

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

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.*location.name* , where *location* is querystring, path, or header; and *name* must be a valid and unique method request parameter name.

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

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

    [1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

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

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

  • :template_selection_expression (String) —

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

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

Returns:



1210
1211
1212
1213
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1210

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:



1259
1260
1261
1262
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1259

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

#create_portal(params = {}) ⇒ Types::CreatePortalResponse

Creates a portal.

Examples:

Request syntax with placeholder values


resp = client.create_portal({
  authorization: { # required
    cognito_config: {
      app_client_id: "__stringMin1Max256", # required
      user_pool_arn: "__stringMin20Max2048", # required
      user_pool_domain: "__stringMin20Max2048", # required
    },
    none: {
    },
  },
  endpoint_configuration: { # required
    acm_managed: {
      certificate_arn: "__stringMin10Max2048", # required
      domain_name: "__stringMin3Max256", # required
    },
    none: {
    },
  },
  included_portal_product_arns: ["__stringMin20Max2048"],
  logo_uri: "__stringMin0Max1092",
  portal_content: { # required
    description: "__stringMin0Max1024",
    display_name: "__stringMin3Max255", # required
    theme: { # required
      custom_colors: { # required
        accent_color: "__stringMin1Max16", # required
        background_color: "__stringMin1Max16", # required
        error_validation_color: "__stringMin1Max16", # required
        header_color: "__stringMin1Max16", # required
        navigation_color: "__stringMin1Max16", # required
        text_color: "__stringMin1Max16", # required
      },
      logo_last_uploaded: Time.now,
    },
  },
  rum_app_monitor_name: "__stringMin0Max255",
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
})

Response structure


resp.authorization.cognito_config.app_client_id #=> String
resp.authorization.cognito_config.user_pool_arn #=> String
resp.authorization.cognito_config.user_pool_domain #=> String
resp.endpoint_configuration.certificate_arn #=> String
resp.endpoint_configuration.domain_name #=> String
resp.endpoint_configuration.portal_default_domain_name #=> String
resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
resp.included_portal_product_arns #=> Array
resp.included_portal_product_arns[0] #=> String
resp.last_modified #=> Time
resp.last_published #=> Time
resp.last_published_description #=> String
resp.portal_arn #=> String
resp.portal_content.description #=> String
resp.portal_content.display_name #=> String
resp.portal_content.theme.custom_colors.accent_color #=> String
resp.portal_content.theme.custom_colors.background_color #=> String
resp.portal_content.theme.custom_colors.error_validation_color #=> String
resp.portal_content.theme.custom_colors.header_color #=> String
resp.portal_content.theme.custom_colors.navigation_color #=> String
resp.portal_content.theme.custom_colors.text_color #=> String
resp.portal_content.theme.logo_last_uploaded #=> Time
resp.portal_id #=> String
resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
resp.rum_app_monitor_name #=> String
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :authorization (required, Types::Authorization) —

    Represents an authorization configuration for a portal.

  • :endpoint_configuration (required, Types::EndpointConfigurationRequest) —

    Represents an endpoint configuration.

  • :included_portal_product_arns (Array<String>)
  • :logo_uri (String)
  • :portal_content (required, Types::PortalContent) —

    Contains the content that is visible to portal consumers including the themes, display names, and description.

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

    Represents a collection of tags associated with the resource.

Returns:



1378
1379
1380
1381
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1378

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

#create_portal_product(params = {}) ⇒ Types::CreatePortalProductResponse

Creates a new portal product.

Examples:

Request syntax with placeholder values


resp = client.create_portal_product({
  description: "__stringMin0Max1024",
  display_name: "__stringMin1Max255", # required
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
})

Response structure


resp.description #=> String
resp.display_name #=> String
resp.display_order.contents #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
resp.display_order.contents[0].section_name #=> String
resp.display_order.overview_page_arn #=> String
resp.display_order.product_page_arns #=> Array
resp.display_order.product_page_arns[0] #=> String
resp.last_modified #=> Time
resp.portal_product_arn #=> String
resp.portal_product_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Represents a collection of tags associated with the resource.

Returns:



1431
1432
1433
1434
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1431

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

#create_product_page(params = {}) ⇒ Types::CreateProductPageResponse

Creates a new product page for a portal product.

Examples:

Request syntax with placeholder values


resp = client.create_product_page({
  display_content: { # required
    body: "__stringMin1Max32768", # required
    title: "__stringMin1Max255", # required
  },
  portal_product_id: "__string", # required
})

Response structure


resp.display_content.body #=> String
resp.display_content.title #=> String
resp.last_modified #=> Time
resp.product_page_arn #=> String
resp.product_page_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_content (required, Types::DisplayContent) —

    The content of the product page.

  • :portal_product_id (required, String)

Returns:



1470
1471
1472
1473
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1470

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

#create_product_rest_endpoint_page(params = {}) ⇒ Types::CreateProductRestEndpointPageResponse

Creates a product REST endpoint page for a portal product.

Examples:

Request syntax with placeholder values


resp = client.create_product_rest_endpoint_page({
  display_content: {
    none: {
    },
    overrides: {
      body: "__stringMin1Max32768",
      endpoint: "__stringMin1Max1024",
      operation_name: "__stringMin1Max255",
    },
  },
  portal_product_id: "__string", # required
  rest_endpoint_identifier: { # required
    identifier_parts: {
      method: "__stringMin1Max20", # required
      path: "__stringMin1Max4096", # required
      rest_api_id: "__stringMin1Max50", # required
      stage: "__stringMin1Max128", # required
    },
  },
  try_it_state: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.display_content.body #=> String
resp.display_content.endpoint #=> String
resp.display_content.operation_name #=> String
resp.last_modified #=> Time
resp.product_rest_endpoint_page_arn #=> String
resp.product_rest_endpoint_page_id #=> String
resp.rest_endpoint_identifier.identifier_parts.method #=> String
resp.rest_endpoint_identifier.identifier_parts.path #=> String
resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
resp.rest_endpoint_identifier.identifier_parts.stage #=> String
resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.try_it_state #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :display_content (Types::EndpointDisplayContent) —

    Represents the endpoint display content.

  • :portal_product_id (required, String)
  • :rest_endpoint_identifier (required, Types::RestEndpointIdentifier) —

    The REST API endpoint identifier.

  • :try_it_state (String) —

    Represents the try it state for a product REST endpoint page.

Returns:



1542
1543
1544
1545
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1542

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

Returns:



1672
1673
1674
1675
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1672

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

Returns:



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

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

#create_routing_rule(params = {}) ⇒ Types::CreateRoutingRuleResponse

Create a routing rule.

Examples:

Request syntax with placeholder values


resp = client.create_routing_rule({
  actions: [ # required
    {
      invoke_api: { # required
        api_id: "Id", # required
        stage: "StringWithLengthBetween1And128", # required
        strip_base_path: false,
      },
    },
  ],
  conditions: [ # required
    {
      match_base_paths: {
        any_of: ["SelectionKey"], # required
      },
      match_headers: {
        any_of: [ # required
          {
            header: "SelectionKey", # required
            value_glob: "SelectionExpression", # required
          },
        ],
      },
    },
  ],
  domain_name: "__string", # required
  domain_name_id: "__string",
  priority: 1, # required
})

Response structure


resp.actions #=> Array
resp.actions[0].invoke_api.api_id #=> String
resp.actions[0].invoke_api.stage #=> String
resp.actions[0].invoke_api.strip_base_path #=> Boolean
resp.conditions #=> Array
resp.conditions[0].match_base_paths.any_of #=> Array
resp.conditions[0].match_base_paths.any_of[0] #=> String
resp.conditions[0].match_headers.any_of #=> Array
resp.conditions[0].match_headers.any_of[0].header #=> String
resp.conditions[0].match_headers.any_of[0].value_glob #=> String
resp.priority #=> Integer
resp.routing_rule_arn #=> String
resp.routing_rule_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :actions (required, Array<Types::RoutingRuleAction>)
  • :conditions (required, Array<Types::RoutingRuleCondition>)
  • :domain_name (required, String)
  • :domain_name_id (String)
  • :priority (required, Integer) —

    The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can’t have the same priority. Priority values 1-1,000,000 are supported.

Returns:



1822
1823
1824
1825
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1822

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

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

Creates a Stage for an API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :access_log_settings (Types::AccessLogSettings) —

    Settings for logging access in a stage.

  • :api_id (required, String)
  • :auto_deploy (Boolean)
  • :client_certificate_id (String) —

    The identifier.

  • :default_route_settings (Types::RouteSettings) —

    Represents a collection of route settings.

  • :deployment_id (String) —

    The identifier.

  • :description (String) —

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

  • :route_settings (Hash<String,Types::RouteSettings>) —

    The route settings map.

  • :stage_name (required, String) —

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

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

    The stage variable map.

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

    Represents a collection of tags associated with the resource.

Returns:



1945
1946
1947
1948
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 1945

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

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

Creates a VPC link.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :security_group_ids (Array<String>) —

    A list of security group IDs for the VPC link.

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

    A list of subnet IDs to include in the VPC link.

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

    Represents a collection of tags associated with the resource.

Returns:



2004
2005
2006
2007
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2004

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

#delete_access_log_settings(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.



2027
2028
2029
2030
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2027

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

#delete_api(params = {}) ⇒ Struct

Deletes an Api resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :api_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2046
2047
2048
2049
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2046

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.



2068
2069
2070
2071
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2068

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.



2090
2091
2092
2093
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2090

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.



2109
2110
2111
2112
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2109

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.



2131
2132
2133
2134
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2131

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.



2150
2151
2152
2153
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2150

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.



2172
2173
2174
2175
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2172

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.



2197
2198
2199
2200
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2197

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.



2219
2220
2221
2222
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2219

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

#delete_portal(params = {}) ⇒ Struct

Deletes a portal.

Examples:

Request syntax with placeholder values


resp = client.delete_portal({
  portal_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2238
2239
2240
2241
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2238

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

#delete_portal_product(params = {}) ⇒ Struct

Deletes a portal product.

Examples:

Request syntax with placeholder values


resp = client.delete_portal_product({
  portal_product_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2257
2258
2259
2260
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2257

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

#delete_portal_product_sharing_policy(params = {}) ⇒ Struct

Deletes the sharing policy for a portal product.

Examples:

Request syntax with placeholder values


resp = client.delete_portal_product_sharing_policy({
  portal_product_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2276
2277
2278
2279
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2276

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

#delete_product_page(params = {}) ⇒ Struct

Deletes a product page of a portal product.

Examples:

Request syntax with placeholder values


resp = client.delete_product_page({
  portal_product_id: "__string", # required
  product_page_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)
  • :product_page_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2298
2299
2300
2301
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2298

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

#delete_product_rest_endpoint_page(params = {}) ⇒ Struct

Deletes a product REST endpoint page.

Examples:

Request syntax with placeholder values


resp = client.delete_product_rest_endpoint_page({
  portal_product_id: "__string", # required
  product_rest_endpoint_page_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)
  • :product_rest_endpoint_page_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2320
2321
2322
2323
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2320

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



2342
2343
2344
2345
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2342

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

#delete_route_request_parameter(params = {}) ⇒ Struct

Deletes a route request parameter. Supported only for WebSocket APIs.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.



2367
2368
2369
2370
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2367

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

#delete_route_response(params = {}) ⇒ Struct

Deletes a RouteResponse.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.



2392
2393
2394
2395
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2392

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

#delete_route_settings(params = {}) ⇒ Struct

Deletes the RouteSettings for a stage.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.



2417
2418
2419
2420
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2417

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

#delete_routing_rule(params = {}) ⇒ Struct

Deletes a routing rule.

Examples:

Request syntax with placeholder values


resp = client.delete_routing_rule({
  domain_name: "__string", # required
  domain_name_id: "__string",
  routing_rule_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)
  • :domain_name_id (String)
  • :routing_rule_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2442
2443
2444
2445
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2442

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



2464
2465
2466
2467
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2464

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

#delete_vpc_link(params = {}) ⇒ Struct

Deletes a VPC link.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



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

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

#disable_portal(params = {}) ⇒ Struct

Deletes the publication of a portal portal.

Examples:

Request syntax with placeholder values


resp = client.disable_portal({
  portal_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



2543
2544
2545
2546
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2543

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.body #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



2524
2525
2526
2527
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2524

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

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

Gets an Api resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack"
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:



2635
2636
2637
2638
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2635

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:



2669
2670
2671
2672
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2669

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:



2706
2707
2708
2709
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2706

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

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

Gets a collection of Api resources.

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].api_endpoint #=> String
resp.items[0].api_gateway_managed #=> Boolean
resp.items[0].api_id #=> String
resp.items[0].api_key_selection_expression #=> String
resp.items[0].cors_configuration.allow_credentials #=> Boolean
resp.items[0].cors_configuration.allow_headers #=> Array
resp.items[0].cors_configuration.allow_headers[0] #=> String
resp.items[0].cors_configuration.allow_methods #=> Array
resp.items[0].cors_configuration.allow_methods[0] #=> String
resp.items[0].cors_configuration.allow_origins #=> Array
resp.items[0].cors_configuration.allow_origins[0] #=> String
resp.items[0].cors_configuration.expose_headers #=> Array
resp.items[0].cors_configuration.expose_headers[0] #=> String
resp.items[0].cors_configuration.max_age #=> Integer
resp.items[0].created_date #=> Time
resp.items[0].description #=> String
resp.items[0].disable_schema_validation #=> Boolean
resp.items[0].disable_execute_api_endpoint #=> Boolean
resp.items[0].import_info #=> Array
resp.items[0].import_info[0] #=> String
resp.items[0].ip_address_type #=> String, one of "ipv4", "dualstack"
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:



2765
2766
2767
2768
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2765

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

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

Gets an Authorizer.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



2816
2817
2818
2819
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2816

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

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

Gets the Authorizers for an API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



2863
2864
2865
2866
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2863

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:



2901
2902
2903
2904
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2901

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:



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

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_arn #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].ip_address_type #=> String, one of "ipv4", "dualstack"
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String
resp.routing_mode #=> String, one of "API_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_API_MAPPING"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)

Returns:



2992
2993
2994
2995
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2992

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 Amazon Web Services 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_arn #=> String
resp.items[0].domain_name_configurations #=> Array
resp.items[0].domain_name_configurations[0].api_gateway_domain_name #=> String
resp.items[0].domain_name_configurations[0].certificate_arn #=> String
resp.items[0].domain_name_configurations[0].certificate_name #=> String
resp.items[0].domain_name_configurations[0].certificate_upload_date #=> Time
resp.items[0].domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.items[0].domain_name_configurations[0].domain_name_status_message #=> String
resp.items[0].domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.items[0].domain_name_configurations[0].hosted_zone_id #=> String
resp.items[0].domain_name_configurations[0].ip_address_type #=> String, one of "ipv4", "dualstack"
resp.items[0].domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.items[0].domain_name_configurations[0].ownership_verification_certificate_arn #=> String
resp.items[0].mutual_tls_authentication.truststore_uri #=> String
resp.items[0].mutual_tls_authentication.truststore_version #=> String
resp.items[0].mutual_tls_authentication.truststore_warnings #=> Array
resp.items[0].mutual_tls_authentication.truststore_warnings[0] #=> String
resp.items[0].routing_mode #=> String, one of "API_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_API_MAPPING"
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:



3044
3045
3046
3047
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3044

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

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

Gets an Integration.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



3114
3115
3116
3117
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3114

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:



3157
3158
3159
3160
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3157

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:



3201
3202
3203
3204
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3201

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

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

Gets the Integrations for an API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



3258
3259
3260
3261
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3258

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:



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

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:



3322
3323
3324
3325
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3322

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:



3360
3361
3362
3363
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3360

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

#get_portal(params = {}) ⇒ Types::GetPortalResponse

Gets a portal.

Examples:

Request syntax with placeholder values


resp = client.get_portal({
  portal_id: "__string", # required
})

Response structure


resp.authorization.cognito_config.app_client_id #=> String
resp.authorization.cognito_config.user_pool_arn #=> String
resp.authorization.cognito_config.user_pool_domain #=> String
resp.endpoint_configuration.certificate_arn #=> String
resp.endpoint_configuration.domain_name #=> String
resp.endpoint_configuration.portal_default_domain_name #=> String
resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
resp.included_portal_product_arns #=> Array
resp.included_portal_product_arns[0] #=> String
resp.last_modified #=> Time
resp.last_published #=> Time
resp.last_published_description #=> String
resp.portal_arn #=> String
resp.portal_content.description #=> String
resp.portal_content.display_name #=> String
resp.portal_content.theme.custom_colors.accent_color #=> String
resp.portal_content.theme.custom_colors.background_color #=> String
resp.portal_content.theme.custom_colors.error_validation_color #=> String
resp.portal_content.theme.custom_colors.header_color #=> String
resp.portal_content.theme.custom_colors.navigation_color #=> String
resp.portal_content.theme.custom_colors.text_color #=> String
resp.portal_content.theme.logo_last_uploaded #=> Time
resp.portal_id #=> String
resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
resp.preview.preview_url #=> String
resp.preview.status_exception.exception #=> String
resp.preview.status_exception.message #=> String
resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
resp.rum_app_monitor_name #=> String
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String)

Returns:



3430
3431
3432
3433
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3430

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

#get_portal_product(params = {}) ⇒ Types::GetPortalProductResponse

Gets a portal product.

Examples:

Request syntax with placeholder values


resp = client.get_portal_product({
  portal_product_id: "__string", # required
  resource_owner_account_id: "__string",
})

Response structure


resp.description #=> String
resp.display_name #=> String
resp.display_order.contents #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
resp.display_order.contents[0].section_name #=> String
resp.display_order.overview_page_arn #=> String
resp.display_order.product_page_arns #=> Array
resp.display_order.product_page_arns[0] #=> String
resp.last_modified #=> Time
resp.portal_product_arn #=> String
resp.portal_product_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)
  • :resource_owner_account_id (String)

Returns:



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

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

#get_portal_product_sharing_policy(params = {}) ⇒ Types::GetPortalProductSharingPolicyResponse

Gets the sharing policy for a portal product.

Examples:

Request syntax with placeholder values


resp = client.get_portal_product_sharing_policy({
  portal_product_id: "__string", # required
})

Response structure


resp.policy_document #=> String
resp.portal_product_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)

Returns:



3504
3505
3506
3507
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3504

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

#get_product_page(params = {}) ⇒ Types::GetProductPageResponse

Gets a product page of a portal product.

Examples:

Request syntax with placeholder values


resp = client.get_product_page({
  portal_product_id: "__string", # required
  product_page_id: "__string", # required
  resource_owner_account_id: "__string",
})

Response structure


resp.display_content.body #=> String
resp.display_content.title #=> String
resp.last_modified #=> Time
resp.product_page_arn #=> String
resp.product_page_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_product_id (required, String)
  • :product_page_id (required, String)
  • :resource_owner_account_id (String)

Returns:



3542
3543
3544
3545
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3542

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

#get_product_rest_endpoint_page(params = {}) ⇒ Types::GetProductRestEndpointPageResponse

Gets a product REST endpoint page.

Examples:

Request syntax with placeholder values


resp = client.get_product_rest_endpoint_page({
  include_raw_display_content: "__string",
  portal_product_id: "__string", # required
  product_rest_endpoint_page_id: "__string", # required
  resource_owner_account_id: "__string",
})

Response structure


resp.display_content.body #=> String
resp.display_content.endpoint #=> String
resp.display_content.operation_name #=> String
resp.last_modified #=> Time
resp.product_rest_endpoint_page_arn #=> String
resp.product_rest_endpoint_page_id #=> String
resp.raw_display_content #=> String
resp.rest_endpoint_identifier.identifier_parts.method #=> String
resp.rest_endpoint_identifier.identifier_parts.path #=> String
resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
resp.rest_endpoint_identifier.identifier_parts.stage #=> String
resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.try_it_state #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :include_raw_display_content (String)
  • :portal_product_id (required, String)
  • :product_rest_endpoint_page_id (required, String)
  • :resource_owner_account_id (String)

Returns:



3598
3599
3600
3601
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3598

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



3653
3654
3655
3656
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3653

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:



3694
3695
3696
3697
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3694

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:



3737
3738
3739
3740
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3737

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:



3786
3787
3788
3789
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3786

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

#get_routing_rule(params = {}) ⇒ Types::GetRoutingRuleResponse

Gets a routing rule.

Examples:

Request syntax with placeholder values


resp = client.get_routing_rule({
  domain_name: "__string", # required
  domain_name_id: "__string",
  routing_rule_id: "__string", # required
})

Response structure


resp.actions #=> Array
resp.actions[0].invoke_api.api_id #=> String
resp.actions[0].invoke_api.stage #=> String
resp.actions[0].invoke_api.strip_base_path #=> Boolean
resp.conditions #=> Array
resp.conditions[0].match_base_paths.any_of #=> Array
resp.conditions[0].match_base_paths.any_of[0] #=> String
resp.conditions[0].match_headers.any_of #=> Array
resp.conditions[0].match_headers.any_of[0].header #=> String
resp.conditions[0].match_headers.any_of[0].value_glob #=> String
resp.priority #=> Integer
resp.routing_rule_arn #=> String
resp.routing_rule_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)
  • :domain_name_id (String)
  • :routing_rule_id (required, String)

Returns:



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

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

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

Gets a Stage.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



3899
3900
3901
3902
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3899

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

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

Gets the Stages for an API.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:



3958
3959
3960
3961
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3958

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:



3984
3985
3986
3987
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 3984

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

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

Gets a VPC link.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_link_id (required, String)

Returns:



4028
4029
4030
4031
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4028

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

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

Gets a collection of VPC links.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:



4070
4071
4072
4073
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4070

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

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

Imports an API.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack"
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:



4145
4146
4147
4148
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4145

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

#list_portal_products(params = {}) ⇒ Types::ListPortalProductsResponse

Lists portal products.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].description #=> String
resp.items[0].display_name #=> String
resp.items[0].last_modified #=> Time
resp.items[0].portal_product_arn #=> String
resp.items[0].portal_product_id #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)
  • :resource_owner (String)

Returns:



4187
4188
4189
4190
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4187

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

#list_portals(params = {}) ⇒ Types::ListPortalsResponse

Lists portals.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.items #=> Array
resp.items[0].authorization.cognito_config.app_client_id #=> String
resp.items[0].authorization.cognito_config.user_pool_arn #=> String
resp.items[0].authorization.cognito_config.user_pool_domain #=> String
resp.items[0].endpoint_configuration.certificate_arn #=> String
resp.items[0].endpoint_configuration.domain_name #=> String
resp.items[0].endpoint_configuration.portal_default_domain_name #=> String
resp.items[0].endpoint_configuration.portal_domain_hosted_zone_id #=> String
resp.items[0].included_portal_product_arns #=> Array
resp.items[0].included_portal_product_arns[0] #=> String
resp.items[0].last_modified #=> Time
resp.items[0].last_published #=> Time
resp.items[0].last_published_description #=> String
resp.items[0].portal_arn #=> String
resp.items[0].portal_content.description #=> String
resp.items[0].portal_content.display_name #=> String
resp.items[0].portal_content.theme.custom_colors.accent_color #=> String
resp.items[0].portal_content.theme.custom_colors.background_color #=> String
resp.items[0].portal_content.theme.custom_colors.error_validation_color #=> String
resp.items[0].portal_content.theme.custom_colors.header_color #=> String
resp.items[0].portal_content.theme.custom_colors.navigation_color #=> String
resp.items[0].portal_content.theme.custom_colors.text_color #=> String
resp.items[0].portal_content.theme.logo_last_uploaded #=> Time
resp.items[0].portal_id #=> String
resp.items[0].preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
resp.items[0].preview.preview_url #=> String
resp.items[0].preview.status_exception.exception #=> String
resp.items[0].preview.status_exception.message #=> String
resp.items[0].publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
resp.items[0].rum_app_monitor_name #=> String
resp.items[0].status_exception.exception #=> String
resp.items[0].status_exception.message #=> String
resp.items[0].tags #=> Hash
resp.items[0].tags["__string"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)

Returns:



4252
4253
4254
4255
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4252

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

#list_product_pages(params = {}) ⇒ Types::ListProductPagesResponse

Lists the product pages for a portal product.

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

Examples:

Request syntax with placeholder values


resp = client.list_product_pages({
  max_results: "__string",
  next_token: "__string",
  portal_product_id: "__string", # required
  resource_owner_account_id: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].last_modified #=> Time
resp.items[0].page_title #=> String
resp.items[0].product_page_arn #=> String
resp.items[0].product_page_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)
  • :portal_product_id (required, String)
  • :resource_owner_account_id (String)

Returns:



4294
4295
4296
4297
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4294

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

#list_product_rest_endpoint_pages(params = {}) ⇒ Types::ListProductRestEndpointPagesResponse

Lists the product REST endpoint pages of a portal product.

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

Examples:

Request syntax with placeholder values


resp = client.list_product_rest_endpoint_pages({
  max_results: "__string",
  next_token: "__string",
  portal_product_id: "__string", # required
  resource_owner_account_id: "__string",
})

Response structure


resp.items #=> Array
resp.items[0].endpoint #=> String
resp.items[0].last_modified #=> Time
resp.items[0].operation_name #=> String
resp.items[0].product_rest_endpoint_page_arn #=> String
resp.items[0].product_rest_endpoint_page_id #=> String
resp.items[0].rest_endpoint_identifier.identifier_parts.method #=> String
resp.items[0].rest_endpoint_identifier.identifier_parts.path #=> String
resp.items[0].rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
resp.items[0].rest_endpoint_identifier.identifier_parts.stage #=> String
resp.items[0].status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
resp.items[0].status_exception.exception #=> String
resp.items[0].status_exception.message #=> String
resp.items[0].try_it_state #=> String, one of "ENABLED", "DISABLED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (String)
  • :next_token (String)
  • :portal_product_id (required, String)
  • :resource_owner_account_id (String)

Returns:



4345
4346
4347
4348
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4345

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

#list_routing_rules(params = {}) ⇒ Types::ListRoutingRulesResponse

Lists routing rules.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.routing_rules #=> Array
resp.routing_rules[0].actions #=> Array
resp.routing_rules[0].actions[0].invoke_api.api_id #=> String
resp.routing_rules[0].actions[0].invoke_api.stage #=> String
resp.routing_rules[0].actions[0].invoke_api.strip_base_path #=> Boolean
resp.routing_rules[0].conditions #=> Array
resp.routing_rules[0].conditions[0].match_base_paths.any_of #=> Array
resp.routing_rules[0].conditions[0].match_base_paths.any_of[0] #=> String
resp.routing_rules[0].conditions[0].match_headers.any_of #=> Array
resp.routing_rules[0].conditions[0].match_headers.any_of[0].header #=> String
resp.routing_rules[0].conditions[0].match_headers.any_of[0].value_glob #=> String
resp.routing_rules[0].priority #=> Integer
resp.routing_rules[0].routing_rule_arn #=> String
resp.routing_rules[0].routing_rule_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String)
  • :domain_name_id (String)
  • :max_results (Integer)
  • :next_token (String)

Returns:



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

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

#preview_portal(params = {}) ⇒ Struct

Creates a portal preview.

Examples:

Request syntax with placeholder values


resp = client.preview_portal({
  portal_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



4415
4416
4417
4418
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4415

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

#publish_portal(params = {}) ⇒ Struct

Publishes a portal.

Examples:

Request syntax with placeholder values


resp = client.publish_portal({
  description: "__stringMin0Max1024",
  portal_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)
  • :portal_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



4437
4438
4439
4440
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4437

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

#put_portal_product_sharing_policy(params = {}) ⇒ Struct

Updates the sharing policy for a portal product.

Examples:

Request syntax with placeholder values


resp = client.put_portal_product_sharing_policy({
  policy_document: "__stringMin1Max307200", # required
  portal_product_id: "__string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :policy_document (required, String)
  • :portal_product_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.



4459
4460
4461
4462
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4459

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

#put_routing_rule(params = {}) ⇒ Types::PutRoutingRuleResponse

Replaces an existing routing rule. When you replace an existing routing rule, the RoutingRuleId isn’t changed.

Examples:

Request syntax with placeholder values


resp = client.put_routing_rule({
  actions: [ # required
    {
      invoke_api: { # required
        api_id: "Id", # required
        stage: "StringWithLengthBetween1And128", # required
        strip_base_path: false,
      },
    },
  ],
  conditions: [ # required
    {
      match_base_paths: {
        any_of: ["SelectionKey"], # required
      },
      match_headers: {
        any_of: [ # required
          {
            header: "SelectionKey", # required
            value_glob: "SelectionExpression", # required
          },
        ],
      },
    },
  ],
  domain_name: "__string", # required
  domain_name_id: "__string",
  priority: 1, # required
  routing_rule_id: "__string", # required
})

Response structure


resp.actions #=> Array
resp.actions[0].invoke_api.api_id #=> String
resp.actions[0].invoke_api.stage #=> String
resp.actions[0].invoke_api.strip_base_path #=> Boolean
resp.conditions #=> Array
resp.conditions[0].match_base_paths.any_of #=> Array
resp.conditions[0].match_base_paths.any_of[0] #=> String
resp.conditions[0].match_headers.any_of #=> Array
resp.conditions[0].match_headers.any_of[0].header #=> String
resp.conditions[0].match_headers.any_of[0].value_glob #=> String
resp.priority #=> Integer
resp.routing_rule_arn #=> String
resp.routing_rule_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :actions (required, Array<Types::RoutingRuleAction>)
  • :conditions (required, Array<Types::RoutingRuleCondition>)
  • :domain_name (required, String)
  • :domain_name_id (String)
  • :priority (required, Integer) —

    The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can’t have the same priority. Priority values 1-1,000,000 are supported.

  • :routing_rule_id (required, String)

Returns:



4541
4542
4543
4544
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4541

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

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

Puts an Api resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack"
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:



4619
4620
4621
4622
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4619

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

#reset_authorizers_cache(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

  • (Struct) —

    Returns an empty response.



2566
2567
2568
2569
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 2566

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

#tag_resource(params = {}) ⇒ Struct

Creates a new Tag resource to represent a tag.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    Represents a collection of tags associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.



4644
4645
4646
4647
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4644

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.



4666
4667
4668
4669
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4666

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

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

Updates an Api resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_endpoint #=> String
resp.api_gateway_managed #=> Boolean
resp.api_id #=> String
resp.api_key_selection_expression #=> String
resp.cors_configuration.allow_credentials #=> Boolean
resp.cors_configuration.allow_headers #=> Array
resp.cors_configuration.allow_headers[0] #=> String
resp.cors_configuration.allow_methods #=> Array
resp.cors_configuration.allow_methods[0] #=> String
resp.cors_configuration.allow_origins #=> Array
resp.cors_configuration.allow_origins[0] #=> String
resp.cors_configuration.expose_headers #=> Array
resp.cors_configuration.expose_headers[0] #=> String
resp.cors_configuration.max_age #=> Integer
resp.created_date #=> Time
resp.description #=> String
resp.disable_schema_validation #=> Boolean
resp.disable_execute_api_endpoint #=> Boolean
resp.import_info #=> Array
resp.import_info[0] #=> String
resp.ip_address_type #=> String, one of "ipv4", "dualstack"
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):

Returns:



4810
4811
4812
4813
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4810

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

Returns:



4863
4864
4865
4866
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4863

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

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

Updates an Authorizer.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Represents an Amazon Resource Name (ARN).

  • :authorizer_id (required, String)
  • :authorizer_result_ttl_in_seconds (Integer) —

    An integer with a value between [0-3600].

  • :authorizer_type (String) —

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

  • :authorizer_uri (String) —

    A string representation of a URI with a length between [1-2048].

  • :identity_source (Array<String>) —

    The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

  • :identity_validation_expression (String) —

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

  • :jwt_configuration (Types::JWTConfiguration) —

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • :name (String) —

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

  • :authorizer_payload_format_version (String) —

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

  • :enable_simple_responses (Boolean)

Returns:



4973
4974
4975
4976
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 4973

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:



5015
5016
5017
5018
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5015

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

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

Updates a domain name.

Examples:

Request syntax with placeholder values


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

Response structure


resp.api_mapping_selection_expression #=> String
resp.domain_name #=> String
resp.domain_name_arn #=> String
resp.domain_name_configurations #=> Array
resp.domain_name_configurations[0].api_gateway_domain_name #=> String
resp.domain_name_configurations[0].certificate_arn #=> String
resp.domain_name_configurations[0].certificate_name #=> String
resp.domain_name_configurations[0].certificate_upload_date #=> Time
resp.domain_name_configurations[0].domain_name_status #=> String, one of "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION"
resp.domain_name_configurations[0].domain_name_status_message #=> String
resp.domain_name_configurations[0].endpoint_type #=> String, one of "REGIONAL", "EDGE"
resp.domain_name_configurations[0].hosted_zone_id #=> String
resp.domain_name_configurations[0].ip_address_type #=> String, one of "ipv4", "dualstack"
resp.domain_name_configurations[0].security_policy #=> String, one of "TLS_1_0", "TLS_1_2"
resp.domain_name_configurations[0].ownership_verification_certificate_arn #=> String
resp.mutual_tls_authentication.truststore_uri #=> String
resp.mutual_tls_authentication.truststore_version #=> String
resp.mutual_tls_authentication.truststore_warnings #=> Array
resp.mutual_tls_authentication.truststore_warnings[0] #=> String
resp.routing_mode #=> String, one of "API_MAPPING_ONLY", "ROUTING_RULE_ONLY", "ROUTING_RULE_THEN_API_MAPPING"
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The domain name configurations.

  • :mutual_tls_authentication (Types::MutualTlsAuthenticationInput) —

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

  • :routing_mode (String) —

    The routing mode API Gateway uses to route traffic to your APIs.

Returns:



5098
5099
5100
5101
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5098

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

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

Updates an Integration.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :connection_type (String) —

    Represents a connection type.

  • :content_handling_strategy (String) —

    Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

  • :credentials_arn (String) —

    Represents an Amazon Resource Name (ARN).

  • :description (String) —

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

  • :integration_id (required, String)
  • :integration_method (String) —

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

  • :integration_subtype (String) —

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

  • :integration_type (String) —

    Represents an API method integration type.

  • :integration_uri (String) —

    A string representation of a URI with a length between [1-2048].

  • :passthrough_behavior (String) —

    Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.

  • :payload_format_version (String) —

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

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

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.*location.name* , where *location* is querystring, path, or header; and *name* must be a valid and unique method request parameter name.

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

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

    [1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

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

    Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.

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

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

  • :template_selection_expression (String) —

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

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

  • :timeout_in_millis (Integer) —

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

  • :tls_config (Types::TlsConfigInput) —

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

Returns:



5289
5290
5291
5292
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5289

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

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

Updates an IntegrationResponses.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.

  • :integration_id (required, String)
  • :integration_response_id (required, String)
  • :integration_response_key (String) —

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

    Selection Expressions][1

    for a list of expressions and each

    expression’s associated selection key type.

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

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

    For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.*location.name* , where *location* is querystring, path, or header; and *name* must be a valid and unique method request parameter name.

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

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

    [1]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

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

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

  • :template_selection_expression (String) —

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

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

Returns:



5401
5402
5403
5404
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5401

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:



5453
5454
5455
5456
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5453

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

#update_portal(params = {}) ⇒ Types::UpdatePortalResponse

Updates a portal.

Examples:

Request syntax with placeholder values


resp = client.update_portal({
  authorization: {
    cognito_config: {
      app_client_id: "__stringMin1Max256", # required
      user_pool_arn: "__stringMin20Max2048", # required
      user_pool_domain: "__stringMin20Max2048", # required
    },
    none: {
    },
  },
  endpoint_configuration: {
    acm_managed: {
      certificate_arn: "__stringMin10Max2048", # required
      domain_name: "__stringMin3Max256", # required
    },
    none: {
    },
  },
  included_portal_product_arns: ["__stringMin20Max2048"],
  logo_uri: "__stringMin0Max1092",
  portal_content: {
    description: "__stringMin0Max1024",
    display_name: "__stringMin3Max255", # required
    theme: { # required
      custom_colors: { # required
        accent_color: "__stringMin1Max16", # required
        background_color: "__stringMin1Max16", # required
        error_validation_color: "__stringMin1Max16", # required
        header_color: "__stringMin1Max16", # required
        navigation_color: "__stringMin1Max16", # required
        text_color: "__stringMin1Max16", # required
      },
      logo_last_uploaded: Time.now,
    },
  },
  portal_id: "__string", # required
  rum_app_monitor_name: "__stringMin0Max255",
})

Response structure


resp.authorization.cognito_config.app_client_id #=> String
resp.authorization.cognito_config.user_pool_arn #=> String
resp.authorization.cognito_config.user_pool_domain #=> String
resp.endpoint_configuration.certificate_arn #=> String
resp.endpoint_configuration.domain_name #=> String
resp.endpoint_configuration.portal_default_domain_name #=> String
resp.endpoint_configuration.portal_domain_hosted_zone_id #=> String
resp.included_portal_product_arns #=> Array
resp.included_portal_product_arns[0] #=> String
resp.last_modified #=> Time
resp.last_published #=> Time
resp.last_published_description #=> String
resp.portal_arn #=> String
resp.portal_content.description #=> String
resp.portal_content.display_name #=> String
resp.portal_content.theme.custom_colors.accent_color #=> String
resp.portal_content.theme.custom_colors.background_color #=> String
resp.portal_content.theme.custom_colors.error_validation_color #=> String
resp.portal_content.theme.custom_colors.header_color #=> String
resp.portal_content.theme.custom_colors.navigation_color #=> String
resp.portal_content.theme.custom_colors.text_color #=> String
resp.portal_content.theme.logo_last_uploaded #=> Time
resp.portal_id #=> String
resp.preview.preview_status #=> String, one of "PREVIEW_IN_PROGRESS", "PREVIEW_FAILED", "PREVIEW_READY"
resp.preview.preview_url #=> String
resp.preview.status_exception.exception #=> String
resp.preview.status_exception.message #=> String
resp.publish_status #=> String, one of "PUBLISHED", "PUBLISH_IN_PROGRESS", "PUBLISH_FAILED", "DISABLE_IN_PROGRESS", "DISABLE_FAILED", "DISABLED"
resp.rum_app_monitor_name #=> String
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :authorization (Types::Authorization) —

    Represents an authorization configuration for a portal.

  • :endpoint_configuration (Types::EndpointConfigurationRequest) —

    Represents an endpoint configuration.

  • :included_portal_product_arns (Array<String>)
  • :logo_uri (String)
  • :portal_content (Types::PortalContent) —

    Contains the content that is visible to portal consumers including the themes, display names, and description.

  • :portal_id (required, String)
  • :rum_app_monitor_name (String)

Returns:



5574
5575
5576
5577
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5574

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

#update_portal_product(params = {}) ⇒ Types::UpdatePortalProductResponse

Updates the portal product.

Examples:

Request syntax with placeholder values


resp = client.update_portal_product({
  description: "__stringMin0Max1024",
  display_name: "__stringMin1Max255",
  display_order: {
    contents: [
      {
        product_rest_endpoint_page_arns: ["__stringMin20Max2048"], # required
        section_name: "__string", # required
      },
    ],
    overview_page_arn: "__stringMin20Max2048",
    product_page_arns: ["__stringMin20Max2048"],
  },
  portal_product_id: "__string", # required
})

Response structure


resp.description #=> String
resp.display_name #=> String
resp.display_order.contents #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns #=> Array
resp.display_order.contents[0].product_rest_endpoint_page_arns[0] #=> String
resp.display_order.contents[0].section_name #=> String
resp.display_order.overview_page_arn #=> String
resp.display_order.product_page_arns #=> Array
resp.display_order.product_page_arns[0] #=> String
resp.last_modified #=> Time
resp.portal_product_arn #=> String
resp.portal_product_id #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)
  • :display_name (String)
  • :display_order (Types::DisplayOrder) —

    The display order.

  • :portal_product_id (required, String)

Returns:



5637
5638
5639
5640
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5637

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

#update_product_page(params = {}) ⇒ Types::UpdateProductPageResponse

Updates a product page of a portal product.

Examples:

Request syntax with placeholder values


resp = client.update_product_page({
  display_content: {
    body: "__stringMin1Max32768", # required
    title: "__stringMin1Max255", # required
  },
  portal_product_id: "__string", # required
  product_page_id: "__string", # required
})

Response structure


resp.display_content.body #=> String
resp.display_content.title #=> String
resp.last_modified #=> Time
resp.product_page_arn #=> String
resp.product_page_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_content (Types::DisplayContent) —

    The content of the product page.

  • :portal_product_id (required, String)
  • :product_page_id (required, String)

Returns:



5679
5680
5681
5682
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5679

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

#update_product_rest_endpoint_page(params = {}) ⇒ Types::UpdateProductRestEndpointPageResponse

Updates a product REST endpoint page.

Examples:

Request syntax with placeholder values


resp = client.update_product_rest_endpoint_page({
  display_content: {
    none: {
    },
    overrides: {
      body: "__stringMin1Max32768",
      endpoint: "__stringMin1Max1024",
      operation_name: "__stringMin1Max255",
    },
  },
  portal_product_id: "__string", # required
  product_rest_endpoint_page_id: "__string", # required
  try_it_state: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.display_content.body #=> String
resp.display_content.endpoint #=> String
resp.display_content.operation_name #=> String
resp.last_modified #=> Time
resp.product_rest_endpoint_page_arn #=> String
resp.product_rest_endpoint_page_id #=> String
resp.rest_endpoint_identifier.identifier_parts.method #=> String
resp.rest_endpoint_identifier.identifier_parts.path #=> String
resp.rest_endpoint_identifier.identifier_parts.rest_api_id #=> String
resp.rest_endpoint_identifier.identifier_parts.stage #=> String
resp.status #=> String, one of "AVAILABLE", "IN_PROGRESS", "FAILED"
resp.status_exception.exception #=> String
resp.status_exception.message #=> String
resp.try_it_state #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :display_content (Types::EndpointDisplayContent) —

    Represents the endpoint display content.

  • :portal_product_id (required, String)
  • :product_rest_endpoint_page_id (required, String)
  • :try_it_state (String) —

    Represents the try it state for a product REST endpoint page.

Returns:



5743
5744
5745
5746
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5743

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

Returns:



5876
5877
5878
5879
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5876

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

Returns:



5951
5952
5953
5954
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 5951

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

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

Updates a Stage.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :access_log_settings (Types::AccessLogSettings) —

    Settings for logging access in a stage.

  • :api_id (required, String)
  • :auto_deploy (Boolean)
  • :client_certificate_id (String) —

    The identifier.

  • :default_route_settings (Types::RouteSettings) —

    Represents a collection of route settings.

  • :deployment_id (String) —

    The identifier.

  • :description (String) —

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

  • :route_settings (Hash<String,Types::RouteSettings>) —

    The route settings map.

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

    The stage variable map.

Returns:



6067
6068
6069
6070
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6067

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

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

Updates a VPC link.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

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

  • :vpc_link_id (required, String)

Returns:



6115
6116
6117
6118
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6115

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

#waiter_names ⇒ Object

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

Deprecated. 


6144
6145
6146
 
# File 'lib/aws-sdk-apigatewayv2/client.rb', line 6144

def waiter_names
  []
end