Class: Aws::LambdaWeb::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]

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

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

    • ~/.aws/credentials

    • ~/.aws/config

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

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

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

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

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

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is 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:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

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

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

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

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

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

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



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

def initialize(*args)
  super
end

Instance Method Details

#create_web_function(params = {}) ⇒ Types::CreateWebFunctionResponse

Creates a web function with an initial revision and endpoint. To create a web function, you provide the function name, revision configuration (code and service settings), and endpoint configuration.

To use this operation, you must have the CreateWebFunction permission on the web function. You don't need separate permissions for the initial revision or endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_web_function({
  function_name: "FunctionName", # required
  revision_config: {
    description: "Description",
    kms_key_arn: "KmsKeyArn",
    build_config: { # required
      code_config: { # required
        s3_object: { # required
          bucket: "S3ObjectBucketString", # required
          key: "S3ObjectKeyString", # required
          version_id: "S3ObjectVersionIdString",
        },
      },
      runtime_config: { # required
        runtime: "RuntimeConfigRuntimeString", # required
      },
    },
    service_config: { # required
      execution_role_arn: "RoleArn", # required
      timeout_seconds: 1,
      egress_network_connector_arn: "ServiceConfigEgressNetworkConnectorArnString",
      max_concurrency_per_environment: 1,
      environment_variables: {
        "EnvironmentVariablesKeyString" => "EnvironmentVariablesValueString",
      },
      telemetry_config: {
        logging_config: {
          log_group: "LoggingConfigLogGroupString",
          application_log_level: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
          system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
        },
      },
    },
  },
  endpoint_config: {
    endpoint_name: "EndpointName", # required
    description: "Description",
    endpoint_type: "HomeRegion", # required, accepts HomeRegion, MultiRegion, PerRegion
    auth_type: "ApplicationManaged", # required, accepts ApplicationManaged, IamAuth
    auto_deployment_mode: "LatestRevision", # accepts LatestRevision, Disabled
    regions: ["Region"],
    scaling_config: {
      max_environments: 1,
    },
    throttle_config: {
      rate_limit: 1,
    },
  },
  tags: {
    "TagKey" => "TagsValueString",
  },
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.state_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.revision.revision_arn #=> String
resp.revision.revision_id #=> String
resp.revision.description #=> String
resp.revision.state #=> String, one of "Pending", "Active", "Failed"
resp.revision.state_reason #=> String
resp.revision.created_at #=> Time
resp.endpoint.endpoint_arn #=> String
resp.endpoint.endpoint_name #=> String
resp.endpoint.description #=> String
resp.endpoint.endpoint_type #=> String, one of "HomeRegion", "MultiRegion", "PerRegion"
resp.endpoint.domain_name #=> String
resp.endpoint.auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.endpoint.auto_deployment_mode #=> String, one of "LatestRevision", "Disabled"
resp.endpoint.revision_weights #=> Array
resp.endpoint.revision_weights[0].revision_id #=> String
resp.endpoint.revision_weights[0].weight #=> Integer
resp.endpoint.regions #=> Array
resp.endpoint.regions[0] #=> String
resp.endpoint.scaling_config.max_environments #=> Integer
resp.endpoint.throttle_config.rate_limit #=> Integer
resp.endpoint.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.endpoint.state_reason #=> String
resp.endpoint.update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.endpoint.update_status_reason #=> String
resp.endpoint.created_at #=> Time
resp.endpoint.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the web function. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.

  • :revision_config (Types::RevisionConfig) —

    The configuration for the initial revision of the web function, including code and service settings.

  • :endpoint_config (Types::EndpointConfig) —

    The configuration for the initial endpoint of the web function.

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

    A map of tag keys and values to apply to the web function.

Returns:

See Also:



609
610
611
612
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 609

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

#create_web_function_endpoint(params = {}) ⇒ Types::CreateWebFunctionEndpointResponse

Creates an endpoint for a web function. An endpoint exposes the web function over HTTPS and routes traffic to one or more revisions.

To use this operation, you must have the CreateWebFunctionEndpoint permission on the web function, not on the endpoint being created.

Examples:

Request syntax with placeholder values


resp = client.create_web_function_endpoint({
  function_name: "FunctionName", # required
  endpoint_name: "EndpointName", # required
  description: "Description",
  endpoint_type: "HomeRegion", # required, accepts HomeRegion, MultiRegion, PerRegion
  auth_type: "ApplicationManaged", # required, accepts ApplicationManaged, IamAuth
  auto_deployment_mode: "LatestRevision", # accepts LatestRevision, Disabled
  revision_weights: [
    {
      revision_id: "RevisionId", # required
      weight: 1, # required
    },
  ],
  regions: ["Region"],
  scaling_config: {
    max_environments: 1,
  },
  throttle_config: {
    rate_limit: 1,
  },
})

Response structure


resp.function_arn #=> String
resp.endpoint_arn #=> String
resp.endpoint_name #=> String
resp.description #=> String
resp.endpoint_type #=> String, one of "HomeRegion", "MultiRegion", "PerRegion"
resp.domain_name #=> String
resp.auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.auto_deployment_mode #=> String, one of "LatestRevision", "Disabled"
resp.revision_weights #=> Array
resp.revision_weights[0].revision_id #=> String
resp.revision_weights[0].weight #=> Integer
resp.regions #=> Array
resp.regions[0] #=> String
resp.scaling_config.max_environments #=> Integer
resp.throttle_config.rate_limit #=> Integer
resp.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.state_reason #=> String
resp.update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.update_status_reason #=> String
resp.regional_endpoints #=> Hash
resp.regional_endpoints["Region"].domain_name #=> String
resp.regional_endpoints["Region"].auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.regional_endpoints["Region"].revision_weights #=> Array
resp.regional_endpoints["Region"].revision_weights[0].revision_id #=> String
resp.regional_endpoints["Region"].revision_weights[0].weight #=> Integer
resp.regional_endpoints["Region"].scaling_config.max_environments #=> Integer
resp.regional_endpoints["Region"].throttle_config.rate_limit #=> Integer
resp.regional_endpoints["Region"].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.regional_endpoints["Region"].state_reason #=> String
resp.regional_endpoints["Region"].update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.regional_endpoints["Region"].update_status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function to create the endpoint for.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :endpoint_name (required, String) —

    The name of the endpoint to create. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.

  • :description (String) —

    A description of the endpoint.

  • :endpoint_type (required, String) —

    The type of endpoint to create. Determines how traffic is served and routed across Regions.

    Valid values:

    • HomeRegion – Serves traffic from the Region where you created the web function.

    • MultiRegion – Replicates across the Regions that you choose and routes each request to the nearest one.

    • PerRegion – Creates a separate endpoint in each Region that you choose.

  • :auth_type (required, String) —

    The authorization type for the endpoint.

    Valid values:

    • ApplicationManaged – Your application handles authorization.

    • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

  • :auto_deployment_mode (String) —

    The auto-deployment mode for the endpoint. Controls whether the endpoint automatically serves the newest revision. If you don't specify a value, the default is Disabled, and this default is returned in the response.

    Valid values:

    • LatestRevision – The endpoint automatically serves the newest revision.

    • Disabled – Revision routing stays fixed until you change it.

  • :revision_weights (Array<Types::RevisionWeight>) —

    A list of revision weights that determine how traffic is distributed across revisions. You can specify up to two revisions for canary or blue-green deployments.

  • :regions (Array<String>) —

    The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

  • :scaling_config (Types::ScalingConfig) —

    The scaling configuration for the endpoint. There is no default value. If you don't specify a scaling configuration, it is absent from the response.

  • :throttle_config (Types::ThrottleConfig) —

    The throttling configuration for the endpoint. There is no default value. If you don't specify a throttling configuration, it is absent from the response.

Returns:

See Also:



788
789
790
791
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 788

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

#create_web_function_revision(params = {}) ⇒ Types::CreateWebFunctionRevisionResponse

Creates an immutable revision for a web function. A revision represents a specific version of the function code and configuration.

To use this operation, you must have the CreateWebFunctionRevision permission on the web function, not on the revision being created.

Examples:

Request syntax with placeholder values


resp = client.create_web_function_revision({
  function_name: "FunctionName", # required
  description: "Description",
  kms_key_arn: "KmsKeyArn",
  build_config: { # required
    code_config: { # required
      s3_object: { # required
        bucket: "S3ObjectBucketString", # required
        key: "S3ObjectKeyString", # required
        version_id: "S3ObjectVersionIdString",
      },
    },
    runtime_config: { # required
      runtime: "RuntimeConfigRuntimeString", # required
    },
  },
  service_config: { # required
    execution_role_arn: "RoleArn", # required
    timeout_seconds: 1,
    egress_network_connector_arn: "ServiceConfigEgressNetworkConnectorArnString",
    max_concurrency_per_environment: 1,
    environment_variables: {
      "EnvironmentVariablesKeyString" => "EnvironmentVariablesValueString",
    },
    telemetry_config: {
      logging_config: {
        log_group: "LoggingConfigLogGroupString",
        application_log_level: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
        system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
      },
    },
  },
})

Response structure


resp.function_arn #=> String
resp.revision_arn #=> String
resp.revision_id #=> String
resp.description #=> String
resp.kms_key_arn #=> String
resp.build_config.code_config.s3_object.bucket #=> String
resp.build_config.code_config.s3_object.key #=> String
resp.build_config.code_config.s3_object.version_id #=> String
resp.build_config.runtime_config.runtime #=> String
resp.service_config.execution_role_arn #=> String
resp.service_config.timeout_seconds #=> Integer
resp.service_config.egress_network_connector_arn #=> String
resp.service_config.max_concurrency_per_environment #=> Integer
resp.service_config.environment_variables #=> Hash
resp.service_config.environment_variables["EnvironmentVariablesKeyString"] #=> String
resp.service_config.telemetry_config.logging_config.log_group #=> String
resp.service_config.telemetry_config.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.service_config.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.state #=> String, one of "Pending", "Active", "Failed"
resp.state_reason #=> String
resp.errors #=> Array
resp.errors[0].attribute #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :description (String) —

    A description of the revision.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key used to encrypt the revision's code and environment variables.

  • :build_config (required, Types::BuildConfig) —

    The build configuration for the revision, including code location and runtime settings.

  • :service_config (required, Types::ServiceConfig) —

    The service configuration for the revision, including execution role, timeout, and concurrency settings.

Returns:

See Also:



909
910
911
912
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 909

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

#delete_resource_policy(params = {}) ⇒ Struct

Removes the resource-based policy from a web function.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceArn", # required
  revision_id: "PolicyRevisionId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the web function.

  • :revision_id (String) —

    The revision ID of the policy. Use this to prevent deleting a policy that has been updated since you last retrieved it. If you don't specify a value, the policy is deleted regardless of its current revision.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



938
939
940
941
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 938

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

#delete_web_function(params = {}) ⇒ Struct

Deletes a web function and all of its associated revisions and endpoints.

To use this operation, you must have the DeleteWebFunction permission on the web function. You don't need the DeleteWebFunctionRevision or DeleteWebFunctionEndpoint permission.

Examples:

Request syntax with placeholder values


resp = client.delete_web_function({
  function_name: "FunctionName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function to delete.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



974
975
976
977
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 974

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

#delete_web_function_endpoint(params = {}) ⇒ Struct

Deletes a web function endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_web_function_endpoint({
  function_name: "FunctionName", # required
  endpoint_name: "EndpointName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :endpoint_name (required, String) —

    The endpoint to delete.

    You can specify either of the following:

    • The endpoint name, for example my-endpoint.

    • The endpoint ARN.

    The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1018
1019
1020
1021
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1018

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

#delete_web_function_revision(params = {}) ⇒ Struct

Deletes a web function revision. You cannot delete a revision that is currently serving traffic on an endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_web_function_revision({
  function_name: "FunctionName", # required
  revision_id: "RevisionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :revision_id (required, String) —

    The revision to delete.

    You can specify either of the following:

    • The revision identifier.

    • The revision ARN.

    The length constraint applies only to the full ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1062
1063
1064
1065
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1062

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Retrieves the resource-based policy attached to a web function.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the web function.

Returns:

See Also:



1092
1093
1094
1095
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1092

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

#get_web_account_settings(params = {}) ⇒ Types::GetWebAccountSettingsResponse

Retrieves details about your AWS Lambda Web Functions account settings for the current AWS Region, including the quotas that apply to web functions and your current usage.

Examples:

Response structure


resp..max_total_arm_v_cpus #=> Integer
resp..max_total_rate_limit #=> Integer
resp..max_revisions_per_function #=> Integer
resp..max_endpoints_per_function #=> Integer
resp..function_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



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

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

#get_web_function(params = {}) ⇒ Types::GetWebFunctionResponse

Retrieves details about a web function, including its current state and configuration.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • web_function_active
  • web_function_deleted

Examples:

Request syntax with placeholder values


resp = client.get_web_function({
  function_name: "FunctionName", # required
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.state_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function to retrieve.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

See Also:



1172
1173
1174
1175
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1172

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

#get_web_function_endpoint(params = {}) ⇒ Types::GetWebFunctionEndpointResponse

Retrieves details about a web function endpoint, including its current state, configuration, and domain name.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • web_function_endpoint_active
  • web_function_endpoint_deleted
  • web_function_endpoint_updated

Examples:

Request syntax with placeholder values


resp = client.get_web_function_endpoint({
  function_name: "FunctionName", # required
  endpoint_name: "EndpointName", # required
})

Response structure


resp.function_arn #=> String
resp.endpoint_arn #=> String
resp.endpoint_name #=> String
resp.description #=> String
resp.endpoint_type #=> String, one of "HomeRegion", "MultiRegion", "PerRegion"
resp.domain_name #=> String
resp.auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.auto_deployment_mode #=> String, one of "LatestRevision", "Disabled"
resp.revision_weights #=> Array
resp.revision_weights[0].revision_id #=> String
resp.revision_weights[0].weight #=> Integer
resp.regions #=> Array
resp.regions[0] #=> String
resp.scaling_config.max_environments #=> Integer
resp.throttle_config.rate_limit #=> Integer
resp.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.state_reason #=> String
resp.update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.update_status_reason #=> String
resp.regional_endpoints #=> Hash
resp.regional_endpoints["Region"].domain_name #=> String
resp.regional_endpoints["Region"].auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.regional_endpoints["Region"].revision_weights #=> Array
resp.regional_endpoints["Region"].revision_weights[0].revision_id #=> String
resp.regional_endpoints["Region"].revision_weights[0].weight #=> Integer
resp.regional_endpoints["Region"].scaling_config.max_environments #=> Integer
resp.regional_endpoints["Region"].throttle_config.rate_limit #=> Integer
resp.regional_endpoints["Region"].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.regional_endpoints["Region"].state_reason #=> String
resp.regional_endpoints["Region"].update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.regional_endpoints["Region"].update_status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :endpoint_name (required, String) —

    The endpoint to retrieve.

    You can specify either of the following:

    • The endpoint name, for example my-endpoint.

    • The endpoint ARN.

    The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

Returns:

See Also:



1280
1281
1282
1283
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1280

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

#get_web_function_revision(params = {}) ⇒ Types::GetWebFunctionRevisionResponse

Retrieves details about a web function revision, including its state and configuration.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • web_function_revision_active

Examples:

Request syntax with placeholder values


resp = client.get_web_function_revision({
  function_name: "FunctionName", # required
  revision_id: "RevisionId", # required
})

Response structure


resp.function_arn #=> String
resp.revision_arn #=> String
resp.revision_id #=> String
resp.description #=> String
resp.kms_key_arn #=> String
resp.build_config.code_config.s3_object.bucket #=> String
resp.build_config.code_config.s3_object.key #=> String
resp.build_config.code_config.s3_object.version_id #=> String
resp.build_config.runtime_config.runtime #=> String
resp.service_config.execution_role_arn #=> String
resp.service_config.timeout_seconds #=> Integer
resp.service_config.egress_network_connector_arn #=> String
resp.service_config.max_concurrency_per_environment #=> Integer
resp.service_config.environment_variables #=> Hash
resp.service_config.environment_variables["EnvironmentVariablesKeyString"] #=> String
resp.service_config.telemetry_config.logging_config.log_group #=> String
resp.service_config.telemetry_config.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.service_config.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.state #=> String, one of "Pending", "Active", "Failed"
resp.state_reason #=> String
resp.errors #=> Array
resp.errors[0].attribute #=> String
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :revision_id (required, String) —

    The revision to retrieve.

    You can specify either of the following:

    • The revision identifier.

    • The revision ARN.

    The length constraint applies only to the full ARN.

Returns:

See Also:



1369
1370
1371
1372
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1369

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

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Returns a list of tags applied to a web function.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource: "ResourceArn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) of the web function.

Returns:

See Also:



1398
1399
1400
1401
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1398

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

#list_web_function_endpoints(params = {}) ⇒ Types::ListWebFunctionEndpointsResponse

Lists endpoints for a web function. Use pagination to ensure that the operation returns quickly and successfully.

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_web_function_endpoints({
  function_name: "FunctionName", # required
  filters: [
    {
      name: "FilterNameString", # required
      values: ["FilterValueListMemberString"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].endpoint_arn #=> String
resp.endpoints[0].endpoint_name #=> String
resp.endpoints[0].description #=> String
resp.endpoints[0].endpoint_type #=> String, one of "HomeRegion", "MultiRegion", "PerRegion"
resp.endpoints[0].domain_name #=> String
resp.endpoints[0].auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.endpoints[0].auto_deployment_mode #=> String, one of "LatestRevision", "Disabled"
resp.endpoints[0].revision_weights #=> Array
resp.endpoints[0].revision_weights[0].revision_id #=> String
resp.endpoints[0].revision_weights[0].weight #=> Integer
resp.endpoints[0].regions #=> Array
resp.endpoints[0].regions[0] #=> String
resp.endpoints[0].scaling_config.max_environments #=> Integer
resp.endpoints[0].throttle_config.rate_limit #=> Integer
resp.endpoints[0].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.endpoints[0].state_reason #=> String
resp.endpoints[0].update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.endpoints[0].update_status_reason #=> String
resp.endpoints[0].created_at #=> Time
resp.endpoints[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :filters (Array<Types::Filter>) —

    A list of filters to apply to the results. Supported filter names: authType, autoDeploymentMode, endpointType, state, and updateStatus. If you don't specify a filter, the operation returns all endpoints for the web function.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

  • :next_token (String) —

    The pagination token that's returned by a previous request to retrieve the next page of results.

Returns:

See Also:



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

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

#list_web_function_revisions(params = {}) ⇒ Types::ListWebFunctionRevisionsResponse

Lists revisions for a web function. Use pagination to ensure that the operation returns quickly and successfully.

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_web_function_revisions({
  function_name: "FunctionName", # required
  filters: [
    {
      name: "FilterNameString", # required
      values: ["FilterValueListMemberString"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.revisions #=> Array
resp.revisions[0].revision_arn #=> String
resp.revisions[0].revision_id #=> String
resp.revisions[0].description #=> String
resp.revisions[0].state #=> String, one of "Pending", "Active", "Failed"
resp.revisions[0].state_reason #=> String
resp.revisions[0].created_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :filters (Array<Types::Filter>) —

    A list of filters to apply to the results. The only supported filter name is state. If you don't specify a filter, the operation returns all revisions for the web function.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

  • :next_token (String) —

    The pagination token that's returned by a previous request to retrieve the next page of results.

Returns:

See Also:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1551

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

#list_web_functions(params = {}) ⇒ Types::ListWebFunctionsResponse

Lists web functions in your account. Use pagination to ensure that the operation returns quickly and successfully.

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_web_functions({
  filters: [
    {
      name: "FilterNameString", # required
      values: ["FilterValueListMemberString"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.functions #=> Array
resp.functions[0].function_name #=> String
resp.functions[0].function_arn #=> String
resp.functions[0].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.functions[0].state_reason #=> String
resp.functions[0].created_at #=> Time
resp.functions[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    A list of filters to apply to the results. The only supported filter name is state. If you don't specify a filter, the operation returns all web functions.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. Minimum value of 1, maximum value of 50. Default is 50.

  • :next_token (String) —

    The pagination token that's returned by a previous request to retrieve the next page of results.

Returns:

See Also:



1607
1608
1609
1610
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1607

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

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Adds or updates a resource-based policy on a web function. A resource-based policy grants permissions to other AWS accounts or services to perform actions on the web function.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "ResourceArn", # required
  policy: "ResourcePolicy", # required
  revision_id: "PolicyRevisionId",
})

Response structure


resp.policy #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the web function.

  • :policy (required, String) —

    The JSON-formatted resource-based policy to attach to the web function.

  • :revision_id (String) —

    The revision ID of the existing policy. Use this to prevent conflicts when updating a policy concurrently. If you don't specify a value, the update proceeds without checking the current revision.

Returns:

See Also:



1650
1651
1652
1653
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1650

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a web function. If a tag key already exists, the existing value is overwritten with the new value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagsValueString",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) of the web function.

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

    A map of tag keys and values to add to the web function.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1679
1680
1681
1682
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1679

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a web function.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The Amazon Resource Name (ARN) of the web function.

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

    A list of tag keys to remove from the web function.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1705
1706
1707
1708
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1705

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

#update_web_function_endpoint(params = {}) ⇒ Types::UpdateWebFunctionEndpointResponse

Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.

Examples:

Request syntax with placeholder values


resp = client.update_web_function_endpoint({
  function_name: "FunctionName", # required
  endpoint_name: "EndpointName", # required
  description: "Description",
  auth_type: "ApplicationManaged", # accepts ApplicationManaged, IamAuth
  auto_deployment_mode: "LatestRevision", # accepts LatestRevision, Disabled
  revision_weights: [
    {
      revision_id: "RevisionId", # required
      weight: 1, # required
    },
  ],
  scaling_config: {
    max_environments: 1,
  },
  throttle_config: {
    rate_limit: 1,
  },
})

Response structure


resp.function_arn #=> String
resp.endpoint_arn #=> String
resp.endpoint_name #=> String
resp.description #=> String
resp.endpoint_type #=> String, one of "HomeRegion", "MultiRegion", "PerRegion"
resp.domain_name #=> String
resp.auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.auto_deployment_mode #=> String, one of "LatestRevision", "Disabled"
resp.revision_weights #=> Array
resp.revision_weights[0].revision_id #=> String
resp.revision_weights[0].weight #=> Integer
resp.regions #=> Array
resp.regions[0] #=> String
resp.scaling_config.max_environments #=> Integer
resp.throttle_config.rate_limit #=> Integer
resp.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.state_reason #=> String
resp.update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.update_status_reason #=> String
resp.regional_endpoints #=> Hash
resp.regional_endpoints["Region"].domain_name #=> String
resp.regional_endpoints["Region"].auth_type #=> String, one of "ApplicationManaged", "IamAuth"
resp.regional_endpoints["Region"].revision_weights #=> Array
resp.regional_endpoints["Region"].revision_weights[0].revision_id #=> String
resp.regional_endpoints["Region"].revision_weights[0].weight #=> Integer
resp.regional_endpoints["Region"].scaling_config.max_environments #=> Integer
resp.regional_endpoints["Region"].throttle_config.rate_limit #=> Integer
resp.regional_endpoints["Region"].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.regional_endpoints["Region"].state_reason #=> String
resp.regional_endpoints["Region"].update_status #=> String, one of "InProgress", "Successful", "Failed"
resp.regional_endpoints["Region"].update_status_reason #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The web function.

    You can specify either of the following:

    • The function name, for example my-function.

    • The function ARN.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :endpoint_name (required, String) —

    The endpoint to update.

    You can specify either of the following:

    • The endpoint name, for example my-endpoint.

    • The endpoint ARN.

    The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

  • :description (String) —

    A description of the endpoint. Omit this field to keep the current description.

  • :auth_type (String) —

    The authorization type for the endpoint. Omit this field to keep the current authorization type.

    Valid values:

    • ApplicationManaged – Your application handles authorization.

    • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

  • :auto_deployment_mode (String) —

    The auto-deployment mode for the endpoint. Omit this field to keep the current auto-deployment mode.

    Valid values:

    • LatestRevision – The endpoint automatically serves the newest revision.

    • Disabled – Revision routing stays fixed until you change it.

  • :revision_weights (Array<Types::RevisionWeight>) —

    A list of revision weights that determine how traffic is distributed across revisions.

  • :scaling_config (Types::ScalingConfig) —

    The scaling configuration for the endpoint. Omit this field to keep the current scaling configuration. To clear a previously set maxEnvironments value, specify an empty object.

  • :throttle_config (Types::ThrottleConfig) —

    The throttling configuration for the endpoint. Omit this field to keep the current throttling configuration. To clear a previously set rateLimit value, specify an empty object.

Returns:

See Also:



1862
1863
1864
1865
 
# File 'gems/aws-sdk-lambdaweb/lib/aws-sdk-lambdaweb/client.rb', line 1862

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

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

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

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

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

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

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

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

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

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

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
web_function_active #get_web_function 1 300
web_function_deleted #get_web_function 1 300
web_function_endpoint_active #get_web_function_endpoint 1 300
web_function_endpoint_deleted #get_web_function_endpoint 1 300
web_function_endpoint_updated #get_web_function_endpoint 1 300
web_function_revision_active #get_web_function_revision 1 300

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

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

  • (Errors::TooManyAttemptsError) —

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

  • (Errors::UnexpectedError) —

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

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



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

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end