Class: Aws::Lambda::Client

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

Overview

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

client = Aws::Lambda::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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

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

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :ignore_configured_endpoint_urls (Boolean) —

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

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

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

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

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

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



489
490
491
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 489

def initialize(*args)
  super
end

Instance Method Details

#add_layer_version_permission(params = {}) ⇒ Types::AddLayerVersionPermissionResponse

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

Examples:

Example: To add permissions to a layer version


# The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.

resp = client.add_layer_version_permission({
  action: "lambda:GetLayerVersion", 
  layer_name: "my-layer", 
  principal: "223456789012", 
  statement_id: "xaccount", 
  version_number: 1, 
})

resp.to_h outputs the following:
{
  revision_id: "35d87451-f796-4a3f-a618-95a3671b0a0c", 
  statement: "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}", 
}

Request syntax with placeholder values


resp = client.add_layer_version_permission({
  layer_name: "LayerName", # required
  version_number: 1, # required
  statement_id: "StatementId", # required
  action: "LayerPermissionAllowedAction", # required
  principal: "LayerPermissionAllowedPrincipal", # required
  organization_id: "OrganizationId",
  revision_id: "String",
})

Response structure


resp.statement #=> String
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :version_number (required, Integer) —

    The version number.

  • :statement_id (required, String) —

    An identifier that distinguishes the policy from others on the same layer version.

  • :action (required, String) —

    The API action that grants access to the layer. For example, lambda:GetLayerVersion.

  • :principal (required, String) —

    An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.

  • :organization_id (String) —

    With the principal set to *, grant permission to all accounts in the specified organization.

  • :revision_id (String) —

    Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

Returns:

See Also:



582
583
584
585
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 582

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

#add_permission(params = {}) ⇒ Types::AddPermissionResponse

Grants a principal permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.

Examples:

Example: To grant Amazon S3 permission to invoke a function


# The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from
# a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.

resp = client.add_permission({
  action: "lambda:InvokeFunction", 
  function_name: "my-function", 
  principal: "s3.amazonaws.com", 
  source_account: "123456789012", 
  source_arn: "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*", 
  statement_id: "s3", 
})

resp.to_h outputs the following:
{
  statement: "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}", 
}

Example: To grant another account permission to invoke a function


# The following example adds permission for account 223456789012 invoke a Lambda function named my-function.

resp = client.add_permission({
  action: "lambda:InvokeFunction", 
  function_name: "my-function", 
  principal: "223456789012", 
  statement_id: "xaccount", 
})

resp.to_h outputs the following:
{
  statement: "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}", 
}

Request syntax with placeholder values


resp = client.add_permission({
  function_name: "NamespacedFunctionName", # required
  statement_id: "StatementId", # required
  action: "Action", # required
  principal: "Principal", # required
  source_arn: "Arn",
  function_url_auth_type: "NONE", # accepts NONE, AWS_IAM
  invoked_via_function_url: false,
  source_account: "SourceOwner",
  event_source_token: "EventSourceToken",
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  revision_id: "String",
  principal_org_id: "PrincipalOrgID",
})

Response structure


resp.statement #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :statement_id (required, String) —

    A statement identifier that differentiates the statement from others in the same policy.

  • :action (required, String) —

    The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

  • :principal (required, String) —

    The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

  • :source_arn (String) —

    For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

    Note that Lambda configures the comparison using the StringLike operator.

  • :function_url_auth_type (String) —

    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

  • :invoked_via_function_url (Boolean) —

    Indicates whether the permission applies when the function is invoked through a function URL.

  • :source_account (String) —

    For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this together with SourceArn to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

  • :event_source_token (String) —

    For Alexa Smart Home functions, a token that the invoker must supply.

  • :qualifier (String) —

    Specify a version or alias to add permissions to a published version of the function.

  • :revision_id (String) —

    Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

  • :principal_org_id (String) —

    The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.

Returns:

See Also:



757
758
759
760
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 757

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

#checkpoint_durable_execution(params = {}) ⇒ Types::CheckpointDurableExecutionResponse

Saves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically.

Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-order state updates.

Examples:

Request syntax with placeholder values


resp = client.checkpoint_durable_execution({
  durable_execution_arn: "DurableExecutionArn", # required
  checkpoint_token: "CheckpointToken", # required
  updates: [
    {
      id: "OperationId", # required
      parent_id: "OperationId",
      name: "OperationName",
      type: "EXECUTION", # required, accepts EXECUTION, CONTEXT, STEP, WAIT, CALLBACK, CHAINED_INVOKE
      sub_type: "OperationSubType",
      action: "START", # required, accepts START, SUCCEED, FAIL, RETRY, CANCEL
      payload: "OperationPayload",
      error: {
        error_message: "ErrorMessage",
        error_type: "ErrorType",
        error_data: "ErrorData",
        stack_trace: ["StackTraceEntry"],
      },
      context_options: {
        replay_children: false,
      },
      step_options: {
        next_attempt_delay_seconds: 1,
      },
      wait_options: {
        wait_seconds: 1,
      },
      callback_options: {
        timeout_seconds: 1,
        heartbeat_timeout_seconds: 1,
      },
      chained_invoke_options: {
        function_name: "NamespacedFunctionName", # required
        tenant_id: "TenantId",
        x_amzn_trace_id: "XAmznTraceId",
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.checkpoint_token #=> String
resp.new_execution_state.operations #=> Array
resp.new_execution_state.operations[0].id #=> String
resp.new_execution_state.operations[0].parent_id #=> String
resp.new_execution_state.operations[0].name #=> String
resp.new_execution_state.operations[0].type #=> String, one of "EXECUTION", "CONTEXT", "STEP", "WAIT", "CALLBACK", "CHAINED_INVOKE"
resp.new_execution_state.operations[0].sub_type #=> String
resp.new_execution_state.operations[0].start_timestamp #=> Time
resp.new_execution_state.operations[0].end_timestamp #=> Time
resp.new_execution_state.operations[0].status #=> String, one of "STARTED", "PENDING", "READY", "SUCCEEDED", "FAILED", "CANCELLED", "TIMED_OUT", "STOPPED"
resp.new_execution_state.operations[0].execution_details.input_payload #=> String
resp.new_execution_state.operations[0].context_details.replay_children #=> Boolean
resp.new_execution_state.operations[0].context_details.result #=> String
resp.new_execution_state.operations[0].context_details.error.error_message #=> String
resp.new_execution_state.operations[0].context_details.error.error_type #=> String
resp.new_execution_state.operations[0].context_details.error.error_data #=> String
resp.new_execution_state.operations[0].context_details.error.stack_trace #=> Array
resp.new_execution_state.operations[0].context_details.error.stack_trace[0] #=> String
resp.new_execution_state.operations[0].step_details.attempt #=> Integer
resp.new_execution_state.operations[0].step_details.next_attempt_timestamp #=> Time
resp.new_execution_state.operations[0].step_details.result #=> String
resp.new_execution_state.operations[0].step_details.error.error_message #=> String
resp.new_execution_state.operations[0].step_details.error.error_type #=> String
resp.new_execution_state.operations[0].step_details.error.error_data #=> String
resp.new_execution_state.operations[0].step_details.error.stack_trace #=> Array
resp.new_execution_state.operations[0].step_details.error.stack_trace[0] #=> String
resp.new_execution_state.operations[0].wait_details.scheduled_end_timestamp #=> Time
resp.new_execution_state.operations[0].callback_details.callback_id #=> String
resp.new_execution_state.operations[0].callback_details.result #=> String
resp.new_execution_state.operations[0].callback_details.error.error_message #=> String
resp.new_execution_state.operations[0].callback_details.error.error_type #=> String
resp.new_execution_state.operations[0].callback_details.error.error_data #=> String
resp.new_execution_state.operations[0].callback_details.error.stack_trace #=> Array
resp.new_execution_state.operations[0].callback_details.error.stack_trace[0] #=> String
resp.new_execution_state.operations[0].chained_invoke_details.result #=> String
resp.new_execution_state.operations[0].chained_invoke_details.error.error_message #=> String
resp.new_execution_state.operations[0].chained_invoke_details.error.error_type #=> String
resp.new_execution_state.operations[0].chained_invoke_details.error.error_data #=> String
resp.new_execution_state.operations[0].chained_invoke_details.error.stack_trace #=> Array
resp.new_execution_state.operations[0].chained_invoke_details.error.stack_trace[0] #=> String
resp.new_execution_state.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :durable_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the durable execution.

  • :checkpoint_token (required, String) —

    A unique token that identifies the current checkpoint state. This token is provided by the Lambda runtime and must be used to ensure checkpoints are applied in the correct order. Each checkpoint operation consumes this token and returns a new one.

  • :updates (Array<Types::OperationUpdate>) —

    An array of state updates to apply during this checkpoint. Each update represents a change to the execution state, such as completing a step, starting a callback, or scheduling a timer. Updates are applied atomically as part of the checkpoint operation.

  • :client_token (String) —

    An optional idempotency token to ensure that duplicate checkpoint requests are handled correctly. If provided, Lambda uses this token to detect and handle duplicate requests within a 15-minute window.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



896
897
898
899
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 896

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

#create_alias(params = {}) ⇒ Types::AliasConfiguration

Creates an alias for a Lambda Event Function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Examples:

Example: To create an alias for a Lambda function


# The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.

resp = client.create_alias({
  description: "alias for live version of function", 
  function_name: "my-function", 
  function_version: "1", 
  name: "LIVE", 
})

resp.to_h outputs the following:
{
  alias_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE", 
  description: "alias for live version of function", 
  function_version: "1", 
  name: "LIVE", 
  revision_id: "873282ed-xmpl-4dc8-a069-d0c647e470c6", 
}

Request syntax with placeholder values


resp = client.create_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
  function_version: "VersionWithLatestPublished", # required
  description: "Description",
  routing_config: {
    additional_version_weights: {
      "AdditionalVersion" => 1.0,
    },
  },
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :name (required, String) —

    The name of the alias.

  • :function_version (required, String) —

    The function version that the alias invokes.

  • :description (String) —

    A description of the alias.

  • :routing_config (Types::AliasRoutingConfiguration) —

    The routing configuration of the alias.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1002

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

#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderResponse

Creates a capacity provider that manages compute resources for Lambda Event Functions

Examples:

Request syntax with placeholder values


resp = client.create_capacity_provider({
  capacity_provider_name: "CapacityProviderName", # required
  vpc_config: { # required
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["SecurityGroupId"], # required
  },
  permissions_config: { # required
    capacity_provider_operator_role_arn: "RoleArn", # required
  },
  instance_requirements: {
    architectures: ["x86_64"], # accepts x86_64, arm64
    allowed_instance_types: ["InstanceType"],
    excluded_instance_types: ["InstanceType"],
  },
  capacity_provider_scaling_config: {
    max_v_cpu_count: 1,
    scaling_mode: "Auto", # accepts Auto, Manual
    scaling_policies: [
      {
        predefined_metric_type: "LambdaCapacityProviderAverageCPUUtilization", # required, accepts LambdaCapacityProviderAverageCPUUtilization
        target_value: 1.0, # required
      },
    ],
  },
  kms_key_arn: "KMSKeyArnNonEmpty",
  tags: {
    "TagKey" => "TagValue",
  },
  propagate_tags: {
    mode: "None", # accepts None, Explicit
    explicit_tags: {
      "TagKey" => "TagValue",
    },
  },
  telemetry_config: {
    logging_config: {
      system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
      log_group: "LogGroup",
    },
  },
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.capacity_provider.vpc_config.subnet_ids #=> Array
resp.capacity_provider.vpc_config.subnet_ids[0] #=> String
resp.capacity_provider.vpc_config.security_group_ids #=> Array
resp.capacity_provider.vpc_config.security_group_ids[0] #=> String
resp.capacity_provider.permissions_config.capacity_provider_operator_role_arn #=> String
resp.capacity_provider.instance_requirements.architectures #=> Array
resp.capacity_provider.instance_requirements.architectures[0] #=> String, one of "x86_64", "arm64"
resp.capacity_provider.instance_requirements.allowed_instance_types #=> Array
resp.capacity_provider.instance_requirements.allowed_instance_types[0] #=> String
resp.capacity_provider.instance_requirements.excluded_instance_types #=> Array
resp.capacity_provider.instance_requirements.excluded_instance_types[0] #=> String
resp.capacity_provider.capacity_provider_scaling_config.max_v_cpu_count #=> Integer
resp.capacity_provider.capacity_provider_scaling_config.scaling_mode #=> String, one of "Auto", "Manual"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies #=> Array
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].predefined_metric_type #=> String, one of "LambdaCapacityProviderAverageCPUUtilization"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].target_value #=> Float
resp.capacity_provider.kms_key_arn #=> String
resp.capacity_provider.last_modified #=> Time
resp.capacity_provider.propagate_tags.mode #=> String, one of "None", "Explicit"
resp.capacity_provider.propagate_tags.explicit_tags #=> Hash
resp.capacity_provider.propagate_tags.explicit_tags["TagKey"] #=> String
resp.capacity_provider.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.capacity_provider.telemetry_config.logging_config.log_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_provider_name (required, String) —

    The name of the capacity provider.

  • :vpc_config (required, Types::CapacityProviderVpcConfig) —

    The VPC configuration for the capacity provider, including subnet IDs and security group IDs where compute instances will be launched.

  • :permissions_config (required, Types::CapacityProviderPermissionsConfig) —

    The permissions configuration that specifies the IAM role ARN used by the capacity provider to manage compute resources.

  • :instance_requirements (Types::InstanceRequirements) —

    The instance requirements that specify the compute instance characteristics, including architectures and allowed or excluded instance types.

  • :capacity_provider_scaling_config (Types::CapacityProviderScalingConfig) —

    The scaling configuration that defines how the capacity provider scales compute instances, including maximum vCPU count and scaling policies.

  • :kms_key_arn (String) —

    The ARN of the KMS key used to encrypt data associated with the capacity provider.

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

    A list of tags to associate with the capacity provider.

  • :propagate_tags (Types::PropagateTags) —

    The tag propagation configuration for the capacity provider. Specifies tags to apply to managed resources at launch.

  • :telemetry_config (Types::CapacityProviderTelemetryConfig) —

    The telemetry configuration for the capacity provider. Specifies logging settings for managed resources.

Returns:

See Also:



1126
1127
1128
1129
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1126

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

#create_code_signing_config(params = {}) ⇒ Types::CreateCodeSigningConfigResponse

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

Examples:

Request syntax with placeholder values


resp = client.create_code_signing_config({
  description: "Description",
  allowed_publishers: { # required
    signing_profile_version_arns: ["Arn"], # required
  },
  code_signing_policies: {
    untrusted_artifact_on_deployment: "Warn", # accepts Warn, Enforce
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.code_signing_config.code_signing_config_id #=> String
resp.code_signing_config.code_signing_config_arn #=> String
resp.code_signing_config.description #=> String
resp.code_signing_config.allowed_publishers.signing_profile_version_arns #=> Array
resp.code_signing_config.allowed_publishers.signing_profile_version_arns[0] #=> String
resp.code_signing_config.code_signing_policies.untrusted_artifact_on_deployment #=> String, one of "Warn", "Enforce"
resp.code_signing_config.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    Descriptive name for this code signing configuration.

  • :allowed_publishers (required, Types::AllowedPublishers) —

    Signing profiles for this code signing configuration.

  • :code_signing_policies (Types::CodeSigningPolicies) —

    The code signing policies define the actions to take if the validation checks fail.

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

    A list of tags to add to the code signing configuration.

Returns:

See Also:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1186

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

#create_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

Creates a mapping between an event source and an Lambda Event Function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

^

For information about which configuration parameters apply to each event source, see the following topics.

Examples:

Example: To create a mapping between an event source and an AWS Lambda function


# The following example creates a mapping between an SQS queue and the my-function Lambda function.

resp = client.create_event_source_mapping({
  batch_size: 5, 
  event_source_arn: "arn:aws:sqs:us-west-2:123456789012:my-queue", 
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  batch_size: 5, 
  event_source_arn: "arn:aws:sqs:us-west-2:123456789012:my-queue", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  last_modified: Time.parse(1569284520.333), 
  state: "Creating", 
  state_transition_reason: "USER_INITIATED", 
  uuid: "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", 
}

Request syntax with placeholder values


resp = client.create_event_source_mapping({
  event_source_arn: "Arn",
  function_name: "NamespacedFunctionName", # required
  enabled: false,
  batch_size: 1,
  filter_criteria: {
    filters: [
      {
        pattern: "Pattern",
      },
    ],
  },
  kms_key_arn: "KMSKeyArn",
  metrics_config: {
    metrics: ["EventCount"], # accepts EventCount, ErrorCount, KafkaMetrics
  },
  logging_config: {
    system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
  },
  scaling_config: {
    maximum_concurrency: 1,
  },
  maximum_batching_window_in_seconds: 1,
  parallelization_factor: 1,
  starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP
  starting_position_timestamp: Time.now,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
  maximum_record_age_in_seconds: 1,
  bisect_batch_on_function_error: false,
  maximum_retry_attempts: 1,
  tags: {
    "TagKey" => "TagValue",
  },
  tumbling_window_in_seconds: 1,
  topics: ["Topic"],
  queues: ["Queue"],
  source_access_configurations: [
    {
      type: "BASIC_AUTH", # accepts BASIC_AUTH, VPC_SUBNET, VPC_SECURITY_GROUP, SASL_SCRAM_512_AUTH, SASL_SCRAM_256_AUTH, VIRTUAL_HOST, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH, OAUTHBEARER_SCOPE, OAUTHBEARER_AUDIENCE, OAUTHBEARER_LOGICAL_CLUSTER, OAUTHBEARER_IDENTITY_POOL, IAM_AUTH, IAM_OAUTHBEARER_AUTH
      uri: "URI",
    },
  ],
  self_managed_event_source: {
    endpoints: {
      "KAFKA_BOOTSTRAP_SERVERS" => ["Endpoint"],
    },
  },
  function_response_types: ["ReportBatchItemFailures"], # accepts ReportBatchItemFailures
  amazon_managed_kafka_event_source_config: {
    consumer_group_id: "URI",
    schema_registry_config: {
      schema_registry_uri: "SchemaRegistryUri",
      event_record_format: "JSON", # accepts JSON, SOURCE
      access_configs: [
        {
          type: "BASIC_AUTH", # accepts BASIC_AUTH, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH
          uri: "Arn",
        },
      ],
      schema_validation_configs: [
        {
          attribute: "KEY", # accepts KEY, VALUE
        },
      ],
    },
  },
  self_managed_kafka_event_source_config: {
    consumer_group_id: "URI",
    schema_registry_config: {
      schema_registry_uri: "SchemaRegistryUri",
      event_record_format: "JSON", # accepts JSON, SOURCE
      access_configs: [
        {
          type: "BASIC_AUTH", # accepts BASIC_AUTH, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH
          uri: "Arn",
        },
      ],
      schema_validation_configs: [
        {
          attribute: "KEY", # accepts KEY, VALUE
        },
      ],
    },
    consumption_mode: "Stream", # accepts Stream, Queue
  },
  document_db_event_source_config: {
    database_name: "DatabaseName",
    collection_name: "CollectionName",
    full_document: "UpdateLookup", # accepts UpdateLookup, Default
  },
  provisioned_poller_config: {
    minimum_pollers: 1,
    maximum_pollers: 1,
    poller_group_name: "ProvisionedPollerGroupName",
  },
})

Response structure


resp.uuid #=> String
resp.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.starting_position_timestamp #=> Time
resp.batch_size #=> Integer
resp.maximum_batching_window_in_seconds #=> Integer
resp.parallelization_factor #=> Integer
resp.event_source_arn #=> String
resp.filter_criteria.filters #=> Array
resp.filter_criteria.filters[0].pattern #=> String
resp.filter_criteria_error.error_code #=> String
resp.filter_criteria_error.message #=> String
resp.kms_key_arn #=> String
resp.metrics_config.metrics #=> Array
resp.metrics_config.metrics[0] #=> String, one of "EventCount", "ErrorCount", "KafkaMetrics"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.scaling_config.maximum_concurrency #=> Integer
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String
resp.topics #=> Array
resp.topics[0] #=> String
resp.queues #=> Array
resp.queues[0] #=> String
resp.source_access_configurations #=> Array
resp.source_access_configurations[0].type #=> String, one of "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH", "OAUTHBEARER_SCOPE", "OAUTHBEARER_AUDIENCE", "OAUTHBEARER_LOGICAL_CLUSTER", "OAUTHBEARER_IDENTITY_POOL", "IAM_AUTH", "IAM_OAUTHBEARER_AUTH"
resp.source_access_configurations[0].uri #=> String
resp.self_managed_event_source.endpoints #=> Hash
resp.self_managed_event_source.endpoints["EndPointType"] #=> Array
resp.self_managed_event_source.endpoints["EndPointType"][0] #=> String
resp.maximum_record_age_in_seconds #=> Integer
resp.bisect_batch_on_function_error #=> Boolean
resp.maximum_retry_attempts #=> Integer
resp.tumbling_window_in_seconds #=> Integer
resp.function_response_types #=> Array
resp.function_response_types[0] #=> String, one of "ReportBatchItemFailures"
resp.amazon_managed_kafka_event_source_config.consumer_group_id #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumer_group_id #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumption_mode #=> String, one of "Stream", "Queue"
resp.document_db_event_source_config.database_name #=> String
resp.document_db_event_source_config.collection_name #=> String
resp.document_db_event_source_config.full_document #=> String, one of "UpdateLookup", "Default"
resp.event_source_mapping_arn #=> String
resp.provisioned_poller_config.minimum_pollers #=> Integer
resp.provisioned_poller_config.maximum_pollers #=> Integer
resp.provisioned_poller_config.poller_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_source_arn (String) —

    The Amazon Resource Name (ARN) of the event source.

    • Amazon Kinesis – The ARN of the data stream or a stream consumer.

    • Amazon DynamoDB Streams – The ARN of the stream.

    • Amazon Simple Queue Service – The ARN of the queue.

    • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    • Amazon MQ – The ARN of the broker.

    • Amazon DocumentDB – The ARN of the DocumentDB change stream.

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – MyFunction.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    • Partial ARN – 123456789012:function:MyFunction.

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

  • :enabled (Boolean) —

    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

    Default: True

  • :batch_size (Integer) —

    The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

    • Amazon Kinesis – Default 100. Max 10,000.

    • Amazon DynamoDB Streams – Default 100. Max 10,000.

    • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    • Self-managed Apache Kafka – Default 100. Max 10,000.

    • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    • DocumentDB – Default 100. Max 10,000.

  • :filter_criteria (Types::FilterCriteria) —

    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

  • :kms_key_arn (String) —

    The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

  • :metrics_config (Types::EventSourceMappingMetricsConfig) —

    The metrics configuration for your event source. For more information, see Event source mapping metrics.

  • :logging_config (Types::EventSourceMappingLoggingConfig) — default: Amazon MSK, and self-managed Apache Kafka only —

    The logging configuration for your event source. For more information, see Event source mapping logging.

  • :scaling_config (Types::ScalingConfig) — default: Amazon SQS only —

    The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

  • :maximum_batching_window_in_seconds (Integer) —

    The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

    For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

    Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    Not supported for Kafka event source mappings when ConsumptionMode is Queue.

  • :parallelization_factor (Integer) — default: Kinesis and DynamoDB Streams only —

    The number of batches to process from each shard concurrently.

  • :starting_position (String) —

    The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

    Not supported for Kafka event source mappings when ConsumptionMode is Queue.

  • :starting_position_timestamp (Time, DateTime, Date, Integer, String) —

    With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

    Not supported for Kafka event source mappings when ConsumptionMode is Queue.

  • :destination_config (Types::DestinationConfig) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    A configuration object that specifies the destination of an event after Lambda processes it.

  • :maximum_record_age_in_seconds (Integer) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    Discard records older than the specified age. The default value is infinite (-1).

  • :bisect_batch_on_function_error (Boolean) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    If the function returns an error, split the batch in two and retry.

  • :maximum_retry_attempts (Integer) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    For Kafka Stream consumption mode, the default is -1 (infinite retries; capped at 10 when an on-failure destination is configured). For Kafka Queue consumption mode, the default is 0, and if no on-failure destination is configured the Kafka broker performs retries.

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

    A list of tags to apply to the event source mapping.

  • :tumbling_window_in_seconds (Integer) — default: Kinesis and DynamoDB Streams only —

    The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

  • :topics (Array<String>) —

    The name of the Kafka topic.

  • :queues (Array<String>) — default: MQ —

    The name of the Amazon MQ broker destination queue to consume.

  • :source_access_configurations (Array<Types::SourceAccessConfiguration>) —

    An array of authentication protocols or VPC components required to secure your event source.

  • :self_managed_event_source (Types::SelfManagedEventSource) —

    The self-managed Apache Kafka cluster to receive records from.

  • :function_response_types (Array<String>) — default: Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS —

    A list of current response type enums applied to the event source mapping.

  • :amazon_managed_kafka_event_source_config (Types::AmazonManagedKafkaEventSourceConfig) —

    Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

  • :self_managed_kafka_event_source_config (Types::SelfManagedKafkaEventSourceConfig) —

    Specific configuration settings for a self-managed Apache Kafka event source.

  • :document_db_event_source_config (Types::DocumentDBEventSourceConfig) —

    Specific configuration settings for a DocumentDB event source.

  • :provisioned_poller_config (Types::ProvisionedPollerConfig) — default: Amazon SQS, Amazon MSK, and self-managed Apache Kafka only —

    The provisioned mode configuration for the event source. For more information, see provisioned mode.

Returns:

See Also:



1734
1735
1736
1737
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 1734

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

#create_function(params = {}) ⇒ Types::FunctionConfiguration

Creates a Lambda Event Function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

Examples:

Example: To create a function


# The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and
# environment variable encryption.

resp = client.create_function({
  code: {
    s3_bucket: "my-bucket-1xpuxmplzrlbh", 
    s3_key: "function.zip", 
  }, 
  description: "Process image objects from Amazon S3.", 
  durable_config: {
    execution_timeout: 31622400, 
    retention_period_in_days: 30, 
  }, 
  environment: {
    variables: {
      "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
      "PREFIX" => "inbound", 
    }, 
  }, 
  function_name: "my-function", 
  handler: "index.handler", 
  kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
  memory_size: 256, 
  publish: true, 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  tags: {
    "DEPARTMENT" => "Assets", 
  }, 
  timeout: 15, 
  tracing_config: {
    mode: "Active", 
  }, 
})

resp.to_h outputs the following:
{
  code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
  code_size: 5797206, 
  description: "Process image objects from Amazon S3.", 
  durable_config: {
    execution_timeout: 31622400, 
    retention_period_in_days: 30, 
  }, 
  environment: {
    variables: {
      "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
      "PREFIX" => "inbound", 
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  function_name: "my-function", 
  handler: "index.handler", 
  kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
  last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
  last_update_status: "Successful", 
  memory_size: 256, 
  revision_id: "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  state: "Active", 
  timeout: 15, 
  tracing_config: {
    mode: "Active", 
  }, 
  version: "1", 
}

Request syntax with placeholder values


resp = client.create_function({
  function_name: "FunctionName", # required
  runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, nodejs10.x, nodejs12.x, nodejs14.x, nodejs16.x, nodejs18.x, nodejs20.x, nodejs22.x, nodejs24.x, java8, java8.al2, java11, java17, java21, java25, python2.7, python3.6, python3.7, python3.8, python3.9, python3.10, python3.11, python3.12, python3.13, python3.14, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, dotnet6, dotnet8, dotnet10, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, ruby3.2, ruby3.3, ruby3.4, ruby4.0, provided, provided.al2, provided.al2023, nodejs26.x, python3.15, java8.al2023, java11.al2023, java17.al2023
  role: "RoleArn", # required
  handler: "Handler",
  code: { # required
    zip_file: "data",
    s3_bucket: "S3Bucket",
    s3_key: "S3Key",
    s3_object_version: "S3ObjectVersion",
    s3_object_storage_mode: "COPY", # accepts COPY, REFERENCE
    image_uri: "String",
    source_kms_key_arn: "KMSKeyArn",
  },
  description: "Description",
  timeout: 1,
  memory_size: 1,
  publish: false,
  publish_to: "LATEST_PUBLISHED", # accepts LATEST_PUBLISHED
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
    ipv_6_allowed_for_dual_stack: false,
  },
  package_type: "Zip", # accepts Zip, Image
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  tags: {
    "TagKey" => "TagValue",
  },
  layers: ["LayerVersionArn"],
  file_system_configs: [
    {
      arn: "FileSystemArn", # required
      local_mount_path: "LocalMountPath", # required
      s3_files_config: {
        direct_s3_read: "ENABLED", # accepts ENABLED, DISABLED, AUTO
      },
    },
  ],
  code_signing_config_arn: "CodeSigningConfigArn",
  image_config: {
    entry_point: ["String"],
    command: ["String"],
    working_directory: "WorkingDirectory",
  },
  architectures: ["x86_64"], # accepts x86_64, arm64
  ephemeral_storage: {
    size: 1, # required
  },
  snap_start: {
    apply_on: "PublishedVersions", # accepts PublishedVersions, None
  },
  logging_config: {
    log_format: "JSON", # accepts JSON, Text
    application_log_level: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
    system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
    log_group: "LogGroup",
  },
  tenancy_config: {
    tenant_isolation_mode: "PER_TENANT", # required, accepts PER_TENANT
  },
  capacity_provider_config: {
    lambda_managed_instances_capacity_provider_config: { # required
      capacity_provider_arn: "CapacityProviderArn", # required
      per_execution_environment_max_concurrency: 1,
      execution_environment_memory_gi_b_per_v_cpu: 1.0,
    },
  },
  durable_config: {
    kms_key_arn: "KMSKeyArn",
    retention_period_in_days: 1,
    execution_timeout: 1,
  },
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String
resp.layers #=> Array
resp.layers[0].arn #=> String
resp.layers[0].code_size #=> Integer
resp.layers[0].signing_profile_version_arn #=> String
resp.layers[0].signing_job_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.state_reason #=> String
resp.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.last_update_status_reason #=> String
resp.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.file_system_configs #=> Array
resp.file_system_configs[0].arn #=> String
resp.file_system_configs[0].local_mount_path #=> String
resp.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.signing_profile_version_arn #=> String
resp.signing_job_arn #=> String
resp.package_type #=> String, one of "Zip", "Image"
resp.image_config_response.image_config.entry_point #=> Array
resp.image_config_response.image_config.entry_point[0] #=> String
resp.image_config_response.image_config.command #=> Array
resp.image_config_response.image_config.command[0] #=> String
resp.image_config_response.image_config.working_directory #=> String
resp.image_config_response.error.error_code #=> String
resp.image_config_response.error.message #=> String
resp.architectures #=> Array
resp.architectures[0] #=> String, one of "x86_64", "arm64"
resp.ephemeral_storage.size #=> Integer
resp.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.snap_start.optimization_status #=> String, one of "On", "Off"
resp.runtime_version_config.runtime_version_arn #=> String
resp.runtime_version_config.error.error_code #=> String
resp.runtime_version_config.error.message #=> String
resp.logging_config.log_format #=> String, one of "JSON", "Text"
resp.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.logging_config.log_group #=> String
resp.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.config_sha_256 #=> String
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :runtime (String) —

    The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

    The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

    For a list of all currently supported runtimes, see Supported runtimes.

  • :role (required, String) —

    The Amazon Resource Name (ARN) of the function's execution role.

  • :handler (String) —

    The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

  • :code (required, Types::FunctionCode) —

    The code for the function.

  • :description (String) —

    A description of the function.

  • :timeout (Integer) —

    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see Lambda execution environment.

  • :memory_size (Integer) —

    The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

  • :publish (Boolean) —

    Set to true to publish the first version of the function during creation.

  • :publish_to (String) —

    Specifies where to publish the function version or configuration.

  • :vpc_config (Types::VpcConfig) —

    For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

  • :package_type (String) —

    The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.

  • :dead_letter_config (Types::DeadLetterConfig) —

    A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

  • :environment (Types::Environment) —

    Environment variables that are accessible from function code during execution.

  • :kms_key_arn (String) —

    The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

    • The function's environment variables.

    • The function's Lambda SnapStart snapshots.

    • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

    • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

  • :tracing_config (Types::TracingConfig) —

    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

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

    A list of tags to apply to the function.

  • :layers (Array<String>) —

    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

  • :file_system_configs (Array<Types::FileSystemConfig>) —

    Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

  • :code_signing_config_arn (String) —

    To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

  • :image_config (Types::ImageConfig) —

    Container image configuration values that override the values in the container image Dockerfile.

  • :architectures (Array<String>) —

    The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

  • :ephemeral_storage (Types::EphemeralStorage) —

    The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

  • :snap_start (Types::SnapStart) —

    The function's SnapStart setting.

  • :logging_config (Types::LoggingConfig) —

    The function's Amazon CloudWatch Logs configuration settings.

  • :tenancy_config (Types::TenancyConfig) —

    Configuration for multi-tenant applications that use Lambda functions. Defines tenant isolation settings and resource allocations. Required for functions supporting multiple tenants.

  • :capacity_provider_config (Types::CapacityProviderConfig) —

    Configuration for the capacity provider that manages compute resources for Lambda functions.

  • :durable_config (Types::DurableConfig) —

    Configuration settings for durable functions. Enables creating functions with durability that can remember their state and continue execution even after interruptions.

Returns:

See Also:



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

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

#create_function_url_config(params = {}) ⇒ Types::CreateFunctionUrlConfigResponse

Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Examples:

Request syntax with placeholder values


resp = client.create_function_url_config({
  function_name: "FunctionUrlFunctionName", # required
  qualifier: "FunctionUrlQualifier",
  auth_type: "NONE", # required, accepts NONE, AWS_IAM
  cors: {
    allow_credentials: false,
    allow_headers: ["Header"],
    allow_methods: ["Method"],
    allow_origins: ["Origin"],
    expose_headers: ["Header"],
    max_age: 1,
  },
  invoke_mode: "BUFFERED", # accepts BUFFERED, RESPONSE_STREAM
})

Response structure


resp.function_url #=> String
resp.function_arn #=> String
resp.auth_type #=> String, one of "NONE", "AWS_IAM"
resp.cors.allow_credentials #=> Boolean
resp.cors.allow_headers #=> Array
resp.cors.allow_headers[0] #=> String
resp.cors.allow_methods #=> Array
resp.cors.allow_methods[0] #=> String
resp.cors.allow_origins #=> Array
resp.cors.allow_origins[0] #=> String
resp.cors.expose_headers #=> Array
resp.cors.expose_headers[0] #=> String
resp.cors.max_age #=> Integer
resp.creation_time #=> Time
resp.invoke_mode #=> String, one of "BUFFERED", "RESPONSE_STREAM"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    The alias name.

  • :auth_type (required, String) —

    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

  • :cors (Types::Cors) —

    The cross-origin resource sharing (CORS) settings for your function URL.

  • :invoke_mode (String) —

    Use one of the following options:

    • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

    • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

Returns:

See Also:



2420
2421
2422
2423
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2420

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

#delete_alias(params = {}) ⇒ Struct

Deletes a Lambda Event Function alias.

Examples:

Example: To delete a Lambda function alias


# The following example deletes an alias named BLUE from a function named my-function

resp = client.delete_alias({
  function_name: "my-function", 
  name: "BLUE", 
})

Request syntax with placeholder values


resp = client.delete_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :name (required, String) —

    The name of the alias.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderResponse

Deletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.

Examples:

Request syntax with placeholder values


resp = client.delete_capacity_provider({
  capacity_provider_name: "CapacityProviderName", # required
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.capacity_provider.vpc_config.subnet_ids #=> Array
resp.capacity_provider.vpc_config.subnet_ids[0] #=> String
resp.capacity_provider.vpc_config.security_group_ids #=> Array
resp.capacity_provider.vpc_config.security_group_ids[0] #=> String
resp.capacity_provider.permissions_config.capacity_provider_operator_role_arn #=> String
resp.capacity_provider.instance_requirements.architectures #=> Array
resp.capacity_provider.instance_requirements.architectures[0] #=> String, one of "x86_64", "arm64"
resp.capacity_provider.instance_requirements.allowed_instance_types #=> Array
resp.capacity_provider.instance_requirements.allowed_instance_types[0] #=> String
resp.capacity_provider.instance_requirements.excluded_instance_types #=> Array
resp.capacity_provider.instance_requirements.excluded_instance_types[0] #=> String
resp.capacity_provider.capacity_provider_scaling_config.max_v_cpu_count #=> Integer
resp.capacity_provider.capacity_provider_scaling_config.scaling_mode #=> String, one of "Auto", "Manual"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies #=> Array
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].predefined_metric_type #=> String, one of "LambdaCapacityProviderAverageCPUUtilization"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].target_value #=> Float
resp.capacity_provider.kms_key_arn #=> String
resp.capacity_provider.last_modified #=> Time
resp.capacity_provider.propagate_tags.mode #=> String, one of "None", "Explicit"
resp.capacity_provider.propagate_tags.explicit_tags #=> Hash
resp.capacity_provider.propagate_tags.explicit_tags["TagKey"] #=> String
resp.capacity_provider.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.capacity_provider.telemetry_config.logging_config.log_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_provider_name (required, String) —

    The name of the capacity provider to delete.

Returns:

See Also:



2525
2526
2527
2528
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2525

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

#delete_code_signing_config(params = {}) ⇒ Struct

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

Examples:

Request syntax with placeholder values


resp = client.delete_code_signing_config({
  code_signing_config_arn: "CodeSigningConfigArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :code_signing_config_arn (required, String) —

    The The Amazon Resource Name (ARN) of the code signing configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2548
2549
2550
2551
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2548

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

#delete_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

When you delete an event source mapping, it enters a Deleting state and might not be completely deleted for several seconds.

Examples:

Example: To delete a Lambda function event source mapping


# The following example deletes an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.

resp = client.delete_event_source_mapping({
  uuid: "14e0db71-xmpl-4eb5-b481-8945cf9d10c2", 
})

resp.to_h outputs the following:
{
  batch_size: 5, 
  event_source_arn: "arn:aws:sqs:us-west-2:123456789012:my-queue", 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function", 
  last_modified: Time.parse("2016-11-21T19:49:20.006Z"), 
  state: "Enabled", 
  state_transition_reason: "USER_INITIATED", 
  uuid: "14e0db71-xmpl-4eb5-b481-8945cf9d10c2", 
}

Request syntax with placeholder values


resp = client.delete_event_source_mapping({
  uuid: "UUIDString", # required
})

Response structure


resp.uuid #=> String
resp.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.starting_position_timestamp #=> Time
resp.batch_size #=> Integer
resp.maximum_batching_window_in_seconds #=> Integer
resp.parallelization_factor #=> Integer
resp.event_source_arn #=> String
resp.filter_criteria.filters #=> Array
resp.filter_criteria.filters[0].pattern #=> String
resp.filter_criteria_error.error_code #=> String
resp.filter_criteria_error.message #=> String
resp.kms_key_arn #=> String
resp.metrics_config.metrics #=> Array
resp.metrics_config.metrics[0] #=> String, one of "EventCount", "ErrorCount", "KafkaMetrics"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.scaling_config.maximum_concurrency #=> Integer
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String
resp.topics #=> Array
resp.topics[0] #=> String
resp.queues #=> Array
resp.queues[0] #=> String
resp.source_access_configurations #=> Array
resp.source_access_configurations[0].type #=> String, one of "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH", "OAUTHBEARER_SCOPE", "OAUTHBEARER_AUDIENCE", "OAUTHBEARER_LOGICAL_CLUSTER", "OAUTHBEARER_IDENTITY_POOL", "IAM_AUTH", "IAM_OAUTHBEARER_AUTH"
resp.source_access_configurations[0].uri #=> String
resp.self_managed_event_source.endpoints #=> Hash
resp.self_managed_event_source.endpoints["EndPointType"] #=> Array
resp.self_managed_event_source.endpoints["EndPointType"][0] #=> String
resp.maximum_record_age_in_seconds #=> Integer
resp.bisect_batch_on_function_error #=> Boolean
resp.maximum_retry_attempts #=> Integer
resp.tumbling_window_in_seconds #=> Integer
resp.function_response_types #=> Array
resp.function_response_types[0] #=> String, one of "ReportBatchItemFailures"
resp.amazon_managed_kafka_event_source_config.consumer_group_id #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumer_group_id #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumption_mode #=> String, one of "Stream", "Queue"
resp.document_db_event_source_config.database_name #=> String
resp.document_db_event_source_config.collection_name #=> String
resp.document_db_event_source_config.full_document #=> String, one of "UpdateLookup", "Default"
resp.event_source_mapping_arn #=> String
resp.provisioned_poller_config.minimum_pollers #=> Integer
resp.provisioned_poller_config.maximum_pollers #=> Integer
resp.provisioned_poller_config.poller_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The identifier of the event source mapping.

Returns:

See Also:



2698
2699
2700
2701
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2698

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

#delete_function(params = {}) ⇒ Types::DeleteFunctionResponse

Deletes a Lambda Event Function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

Examples:

Example: To delete a version of a Lambda function


# The following example deletes version 1 of a Lambda function named my-function.

resp = client.delete_function({
  function_name: "my-function", 
  qualifier: "1", 
})

Request syntax with placeholder values


resp = client.delete_function({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


resp.status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function or version.

    Name formats

    • Function name – my-function (name-only), my-function:1 (with version).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    Specify a version to delete. You can't delete a version that an alias references.

Returns:

See Also:



2768
2769
2770
2771
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2768

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

#delete_function_code_signing_config(params = {}) ⇒ Struct

Removes the code signing configuration from the function.

Examples:

Request syntax with placeholder values


resp = client.delete_function_code_signing_config({
  function_name: "NamespacedFunctionName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

    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:



2802
2803
2804
2805
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2802

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

#delete_function_concurrency(params = {}) ⇒ Struct

Removes a concurrent execution limit from a Lambda Event Function.

Examples:

Example: To remove the reserved concurrent execution limit from a function


# The following example deletes the reserved concurrent execution limit from a function named my-function.

resp = client.delete_function_concurrency({
  function_name: "my-function", 
})

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    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:



2845
2846
2847
2848
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2845

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

#delete_function_event_invoke_config(params = {}) ⇒ Struct

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Examples:

Example: To delete an asynchronous invocation configuration


# The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named
# my-function.

resp = client.delete_function_event_invoke_config({
  function_name: "my-function", 
  qualifier: "GREEN", 
})

Request syntax with placeholder values


resp = client.delete_function_event_invoke_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    A version number or alias name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2900
2901
2902
2903
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2900

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

#delete_function_url_config(params = {}) ⇒ Struct

Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.

Examples:

Request syntax with placeholder values


resp = client.delete_function_url_config({
  function_name: "FunctionUrlFunctionName", # required
  qualifier: "FunctionUrlQualifier",
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    The alias name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

#delete_layer_version(params = {}) ⇒ Struct

Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

Examples:

Example: To delete a version of a Lambda layer


# The following example deletes version 2 of a layer named my-layer.

resp = client.delete_layer_version({
  layer_name: "my-layer", 
  version_number: 2, 
})

Request syntax with placeholder values


resp = client.delete_layer_version({
  layer_name: "LayerName", # required
  version_number: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :version_number (required, Integer) —

    The version number.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2982
2983
2984
2985
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 2982

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

#delete_provisioned_concurrency_config(params = {}) ⇒ Struct

Deletes the provisioned concurrency configuration for a function.

Examples:

Example: To delete a provisioned concurrency configuration


# The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named
# my-function.

resp = client.delete_provisioned_concurrency_config({
  function_name: "my-function", 
  qualifier: "GREEN", 
})

Request syntax with placeholder values


resp = client.delete_provisioned_concurrency_config({
  function_name: "FunctionName", # required
  qualifier: "Qualifier", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (required, String) —

    The version number or alias name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3031
3032
3033
3034
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3031

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

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource-based policy from a Lambda resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Lambda resource you want to delete the policy from. You can use a qualified or an unqualified ARN. The value must be a complete ARN, and the operation does not accept wildcard characters.

  • :revision_id (String) —

    The revision ID that the existing policy must match for the deletion to proceed. If the revision ID doesn't match, the operation fails with a PreconditionFailedException error. To retrieve the current revision ID, use the GetResourcePolicy operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3067
3068
3069
3070
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3067

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

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

Examples:

Example: To get account settings


# This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.

resp = client.({
})

resp.to_h outputs the following:
{
  account_limit: {
    code_size_unzipped: 262144000, 
    code_size_zipped: 52428800, 
    concurrent_executions: 1000, 
    total_code_size: 80530636800, 
    unreserved_concurrent_executions: 1000, 
  }, 
  account_usage: {
    function_count: 4, 
    total_code_size: 9426, 
  }, 
}

Response structure


resp..total_code_size #=> Integer
resp..code_size_unzipped #=> Integer
resp..code_size_zipped #=> Integer
resp..concurrent_executions #=> Integer
resp..unreserved_concurrent_executions #=> Integer
resp..total_code_size #=> Integer
resp..function_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



3121
3122
3123
3124
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3121

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

#get_alias(params = {}) ⇒ Types::AliasConfiguration

Returns details about a Lambda Event Function alias.

Examples:

Example: To get a Lambda function alias


# The following example returns details about an alias named BLUE for a function named my-function

resp = client.get_alias({
  function_name: "my-function", 
  name: "BLUE", 
})

resp.to_h outputs the following:
{
  alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", 
  description: "Production environment BLUE.", 
  function_version: "3", 
  name: "BLUE", 
  revision_id: "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", 
}

Request syntax with placeholder values


resp = client.get_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :name (required, String) —

    The name of the alias.

Returns:

See Also:



3199
3200
3201
3202
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3199

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

#get_capacity_provider(params = {}) ⇒ Types::GetCapacityProviderResponse

Retrieves information about a specific capacity provider, including its configuration, state, and associated resources.

Examples:

Request syntax with placeholder values


resp = client.get_capacity_provider({
  capacity_provider_name: "CapacityProviderName", # required
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.capacity_provider.vpc_config.subnet_ids #=> Array
resp.capacity_provider.vpc_config.subnet_ids[0] #=> String
resp.capacity_provider.vpc_config.security_group_ids #=> Array
resp.capacity_provider.vpc_config.security_group_ids[0] #=> String
resp.capacity_provider.permissions_config.capacity_provider_operator_role_arn #=> String
resp.capacity_provider.instance_requirements.architectures #=> Array
resp.capacity_provider.instance_requirements.architectures[0] #=> String, one of "x86_64", "arm64"
resp.capacity_provider.instance_requirements.allowed_instance_types #=> Array
resp.capacity_provider.instance_requirements.allowed_instance_types[0] #=> String
resp.capacity_provider.instance_requirements.excluded_instance_types #=> Array
resp.capacity_provider.instance_requirements.excluded_instance_types[0] #=> String
resp.capacity_provider.capacity_provider_scaling_config.max_v_cpu_count #=> Integer
resp.capacity_provider.capacity_provider_scaling_config.scaling_mode #=> String, one of "Auto", "Manual"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies #=> Array
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].predefined_metric_type #=> String, one of "LambdaCapacityProviderAverageCPUUtilization"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].target_value #=> Float
resp.capacity_provider.kms_key_arn #=> String
resp.capacity_provider.last_modified #=> Time
resp.capacity_provider.propagate_tags.mode #=> String, one of "None", "Explicit"
resp.capacity_provider.propagate_tags.explicit_tags #=> Hash
resp.capacity_provider.propagate_tags.explicit_tags["TagKey"] #=> String
resp.capacity_provider.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.capacity_provider.telemetry_config.logging_config.log_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_provider_name (required, String) —

    The name of the capacity provider to retrieve.

Returns:

See Also:



3252
3253
3254
3255
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3252

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

#get_code_signing_config(params = {}) ⇒ Types::GetCodeSigningConfigResponse

Returns information about the specified code signing configuration.

Examples:

Request syntax with placeholder values


resp = client.get_code_signing_config({
  code_signing_config_arn: "CodeSigningConfigArn", # required
})

Response structure


resp.code_signing_config.code_signing_config_id #=> String
resp.code_signing_config.code_signing_config_arn #=> String
resp.code_signing_config.description #=> String
resp.code_signing_config.allowed_publishers.signing_profile_version_arns #=> Array
resp.code_signing_config.allowed_publishers.signing_profile_version_arns[0] #=> String
resp.code_signing_config.code_signing_policies.untrusted_artifact_on_deployment #=> String, one of "Warn", "Enforce"
resp.code_signing_config.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :code_signing_config_arn (required, String) —

    The The Amazon Resource Name (ARN) of the code signing configuration.

Returns:

See Also:



3286
3287
3288
3289
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3286

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

#get_durable_execution(params = {}) ⇒ Types::GetDurableExecutionResponse

Retrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.

Examples:

Request syntax with placeholder values


resp = client.get_durable_execution({
  durable_execution_arn: "DurableExecutionArn", # required
  include_execution_data: false,
})

Response structure


resp.durable_execution_arn #=> String
resp.durable_execution_name #=> String
resp.function_arn #=> String
resp.input_payload #=> String
resp.result #=> String
resp.error.error_message #=> String
resp.error.error_type #=> String
resp.error.error_data #=> String
resp.error.stack_trace #=> Array
resp.error.stack_trace[0] #=> String
resp.start_timestamp #=> Time
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "STOPPED"
resp.end_timestamp #=> Time
resp.version #=> String
resp.trace_header.x_amzn_trace_id #=> String
resp.execution_data_included #=> Boolean
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :durable_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the durable execution.

  • :include_execution_data (Boolean) —

    Specifies whether to include execution data such as input payload, result, and error information in the response. Set to false for a more compact response that includes only execution metadata. The default value is set to true.

Returns:

See Also:



3358
3359
3360
3361
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3358

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

#get_durable_execution_history(params = {}) ⇒ Types::GetDurableExecutionHistoryResponse

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

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

Examples:

Request syntax with placeholder values


resp = client.get_durable_execution_history({
  durable_execution_arn: "DurableExecutionArn", # required
  include_execution_data: false,
  max_items: 1,
  marker: "String",
  reverse_order: false,
})

Response structure


resp.events #=> Array
resp.events[0].event_type #=> String, one of "ExecutionStarted", "ExecutionSucceeded", "ExecutionFailed", "ExecutionTimedOut", "ExecutionStopped", "ContextStarted", "ContextSucceeded", "ContextFailed", "WaitStarted", "WaitSucceeded", "WaitCancelled", "StepStarted", "StepSucceeded", "StepFailed", "ChainedInvokeStarted", "ChainedInvokeSucceeded", "ChainedInvokeFailed", "ChainedInvokeTimedOut", "ChainedInvokeStopped", "CallbackStarted", "CallbackSucceeded", "CallbackFailed", "CallbackTimedOut", "InvocationCompleted"
resp.events[0].sub_type #=> String
resp.events[0].event_id #=> Integer
resp.events[0].id #=> String
resp.events[0].name #=> String
resp.events[0].event_timestamp #=> Time
resp.events[0].parent_id #=> String
resp.events[0].execution_started_details.input.payload #=> String
resp.events[0].execution_started_details.input.truncated #=> Boolean
resp.events[0].execution_started_details.execution_timeout #=> Integer
resp.events[0].execution_succeeded_details.result.payload #=> String
resp.events[0].execution_succeeded_details.result.truncated #=> Boolean
resp.events[0].execution_failed_details.error.payload.error_message #=> String
resp.events[0].execution_failed_details.error.payload.error_type #=> String
resp.events[0].execution_failed_details.error.payload.error_data #=> String
resp.events[0].execution_failed_details.error.payload.stack_trace #=> Array
resp.events[0].execution_failed_details.error.payload.stack_trace[0] #=> String
resp.events[0].execution_failed_details.error.truncated #=> Boolean
resp.events[0].execution_timed_out_details.error.payload.error_message #=> String
resp.events[0].execution_timed_out_details.error.payload.error_type #=> String
resp.events[0].execution_timed_out_details.error.payload.error_data #=> String
resp.events[0].execution_timed_out_details.error.payload.stack_trace #=> Array
resp.events[0].execution_timed_out_details.error.payload.stack_trace[0] #=> String
resp.events[0].execution_timed_out_details.error.truncated #=> Boolean
resp.events[0].execution_stopped_details.error.payload.error_message #=> String
resp.events[0].execution_stopped_details.error.payload.error_type #=> String
resp.events[0].execution_stopped_details.error.payload.error_data #=> String
resp.events[0].execution_stopped_details.error.payload.stack_trace #=> Array
resp.events[0].execution_stopped_details.error.payload.stack_trace[0] #=> String
resp.events[0].execution_stopped_details.error.truncated #=> Boolean
resp.events[0].context_succeeded_details.result.payload #=> String
resp.events[0].context_succeeded_details.result.truncated #=> Boolean
resp.events[0].context_failed_details.error.payload.error_message #=> String
resp.events[0].context_failed_details.error.payload.error_type #=> String
resp.events[0].context_failed_details.error.payload.error_data #=> String
resp.events[0].context_failed_details.error.payload.stack_trace #=> Array
resp.events[0].context_failed_details.error.payload.stack_trace[0] #=> String
resp.events[0].context_failed_details.error.truncated #=> Boolean
resp.events[0].wait_started_details.duration #=> Integer
resp.events[0].wait_started_details.scheduled_end_timestamp #=> Time
resp.events[0].wait_succeeded_details.duration #=> Integer
resp.events[0].wait_cancelled_details.error.payload.error_message #=> String
resp.events[0].wait_cancelled_details.error.payload.error_type #=> String
resp.events[0].wait_cancelled_details.error.payload.error_data #=> String
resp.events[0].wait_cancelled_details.error.payload.stack_trace #=> Array
resp.events[0].wait_cancelled_details.error.payload.stack_trace[0] #=> String
resp.events[0].wait_cancelled_details.error.truncated #=> Boolean
resp.events[0].step_succeeded_details.result.payload #=> String
resp.events[0].step_succeeded_details.result.truncated #=> Boolean
resp.events[0].step_succeeded_details.retry_details.current_attempt #=> Integer
resp.events[0].step_succeeded_details.retry_details.next_attempt_delay_seconds #=> Integer
resp.events[0].step_failed_details.error.payload.error_message #=> String
resp.events[0].step_failed_details.error.payload.error_type #=> String
resp.events[0].step_failed_details.error.payload.error_data #=> String
resp.events[0].step_failed_details.error.payload.stack_trace #=> Array
resp.events[0].step_failed_details.error.payload.stack_trace[0] #=> String
resp.events[0].step_failed_details.error.truncated #=> Boolean
resp.events[0].step_failed_details.retry_details.current_attempt #=> Integer
resp.events[0].step_failed_details.retry_details.next_attempt_delay_seconds #=> Integer
resp.events[0].chained_invoke_started_details.function_name #=> String
resp.events[0].chained_invoke_started_details.tenant_id #=> String
resp.events[0].chained_invoke_started_details.input.payload #=> String
resp.events[0].chained_invoke_started_details.input.truncated #=> Boolean
resp.events[0].chained_invoke_started_details.executed_version #=> String
resp.events[0].chained_invoke_started_details.durable_execution_arn #=> String
resp.events[0].chained_invoke_succeeded_details.result.payload #=> String
resp.events[0].chained_invoke_succeeded_details.result.truncated #=> Boolean
resp.events[0].chained_invoke_failed_details.error.payload.error_message #=> String
resp.events[0].chained_invoke_failed_details.error.payload.error_type #=> String
resp.events[0].chained_invoke_failed_details.error.payload.error_data #=> String
resp.events[0].chained_invoke_failed_details.error.payload.stack_trace #=> Array
resp.events[0].chained_invoke_failed_details.error.payload.stack_trace[0] #=> String
resp.events[0].chained_invoke_failed_details.error.truncated #=> Boolean
resp.events[0].chained_invoke_timed_out_details.error.payload.error_message #=> String
resp.events[0].chained_invoke_timed_out_details.error.payload.error_type #=> String
resp.events[0].chained_invoke_timed_out_details.error.payload.error_data #=> String
resp.events[0].chained_invoke_timed_out_details.error.payload.stack_trace #=> Array
resp.events[0].chained_invoke_timed_out_details.error.payload.stack_trace[0] #=> String
resp.events[0].chained_invoke_timed_out_details.error.truncated #=> Boolean
resp.events[0].chained_invoke_stopped_details.error.payload.error_message #=> String
resp.events[0].chained_invoke_stopped_details.error.payload.error_type #=> String
resp.events[0].chained_invoke_stopped_details.error.payload.error_data #=> String
resp.events[0].chained_invoke_stopped_details.error.payload.stack_trace #=> Array
resp.events[0].chained_invoke_stopped_details.error.payload.stack_trace[0] #=> String
resp.events[0].chained_invoke_stopped_details.error.truncated #=> Boolean
resp.events[0].callback_started_details.callback_id #=> String
resp.events[0].callback_started_details.heartbeat_timeout #=> Integer
resp.events[0].callback_started_details.timeout #=> Integer
resp.events[0].callback_succeeded_details.result.payload #=> String
resp.events[0].callback_succeeded_details.result.truncated #=> Boolean
resp.events[0].callback_failed_details.error.payload.error_message #=> String
resp.events[0].callback_failed_details.error.payload.error_type #=> String
resp.events[0].callback_failed_details.error.payload.error_data #=> String
resp.events[0].callback_failed_details.error.payload.stack_trace #=> Array
resp.events[0].callback_failed_details.error.payload.stack_trace[0] #=> String
resp.events[0].callback_failed_details.error.truncated #=> Boolean
resp.events[0].callback_timed_out_details.error.payload.error_message #=> String
resp.events[0].callback_timed_out_details.error.payload.error_type #=> String
resp.events[0].callback_timed_out_details.error.payload.error_data #=> String
resp.events[0].callback_timed_out_details.error.payload.stack_trace #=> Array
resp.events[0].callback_timed_out_details.error.payload.stack_trace[0] #=> String
resp.events[0].callback_timed_out_details.error.truncated #=> Boolean
resp.events[0].invocation_completed_details.start_timestamp #=> Time
resp.events[0].invocation_completed_details.end_timestamp #=> Time
resp.events[0].invocation_completed_details.request_id #=> String
resp.events[0].invocation_completed_details.error.payload.error_message #=> String
resp.events[0].invocation_completed_details.error.payload.error_type #=> String
resp.events[0].invocation_completed_details.error.payload.error_data #=> String
resp.events[0].invocation_completed_details.error.payload.stack_trace #=> Array
resp.events[0].invocation_completed_details.error.payload.stack_trace[0] #=> String
resp.events[0].invocation_completed_details.error.truncated #=> Boolean
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :durable_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the durable execution.

  • :include_execution_data (Boolean) —

    Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.

  • :max_items (Integer) —

    The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

  • :marker (String) —

    If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.

  • :reverse_order (Boolean) —

    When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

Returns:

See Also:



3538
3539
3540
3541
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3538

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

#get_durable_execution_state(params = {}) ⇒ Types::GetDurableExecutionStateResponse

Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.

The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.

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

Examples:

Request syntax with placeholder values


resp = client.get_durable_execution_state({
  durable_execution_arn: "DurableExecutionArn", # required
  checkpoint_token: "CheckpointToken", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.operations #=> Array
resp.operations[0].id #=> String
resp.operations[0].parent_id #=> String
resp.operations[0].name #=> String
resp.operations[0].type #=> String, one of "EXECUTION", "CONTEXT", "STEP", "WAIT", "CALLBACK", "CHAINED_INVOKE"
resp.operations[0].sub_type #=> String
resp.operations[0].start_timestamp #=> Time
resp.operations[0].end_timestamp #=> Time
resp.operations[0].status #=> String, one of "STARTED", "PENDING", "READY", "SUCCEEDED", "FAILED", "CANCELLED", "TIMED_OUT", "STOPPED"
resp.operations[0].execution_details.input_payload #=> String
resp.operations[0].context_details.replay_children #=> Boolean
resp.operations[0].context_details.result #=> String
resp.operations[0].context_details.error.error_message #=> String
resp.operations[0].context_details.error.error_type #=> String
resp.operations[0].context_details.error.error_data #=> String
resp.operations[0].context_details.error.stack_trace #=> Array
resp.operations[0].context_details.error.stack_trace[0] #=> String
resp.operations[0].step_details.attempt #=> Integer
resp.operations[0].step_details.next_attempt_timestamp #=> Time
resp.operations[0].step_details.result #=> String
resp.operations[0].step_details.error.error_message #=> String
resp.operations[0].step_details.error.error_type #=> String
resp.operations[0].step_details.error.error_data #=> String
resp.operations[0].step_details.error.stack_trace #=> Array
resp.operations[0].step_details.error.stack_trace[0] #=> String
resp.operations[0].wait_details.scheduled_end_timestamp #=> Time
resp.operations[0].callback_details.callback_id #=> String
resp.operations[0].callback_details.result #=> String
resp.operations[0].callback_details.error.error_message #=> String
resp.operations[0].callback_details.error.error_type #=> String
resp.operations[0].callback_details.error.error_data #=> String
resp.operations[0].callback_details.error.stack_trace #=> Array
resp.operations[0].callback_details.error.stack_trace[0] #=> String
resp.operations[0].chained_invoke_details.result #=> String
resp.operations[0].chained_invoke_details.error.error_message #=> String
resp.operations[0].chained_invoke_details.error.error_type #=> String
resp.operations[0].chained_invoke_details.error.error_data #=> String
resp.operations[0].chained_invoke_details.error.stack_trace #=> Array
resp.operations[0].chained_invoke_details.error.stack_trace[0] #=> String
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :durable_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the durable execution.

  • :checkpoint_token (required, String) —

    A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.

  • :marker (String) —

    If NextMarker was returned from a previous request, use this value to retrieve the next page of operations. Each pagination token expires after 24 hours.

  • :max_items (Integer) —

    The maximum number of operations to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

Returns:

See Also:



3638
3639
3640
3641
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3638

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

#get_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

Examples:

Example: To get a Lambda function's event source mapping


# The following example returns details about an event source mapping. To get a mapping's UUID, use
# ListEventSourceMappings.

resp = client.get_event_source_mapping({
  uuid: "14e0db71-xmpl-4eb5-b481-8945cf9d10c2", 
})

resp.to_h outputs the following:
{
  batch_size: 500, 
  bisect_batch_on_function_error: false, 
  destination_config: {
  }, 
  event_source_arn: "arn:aws:sqs:us-east-2:123456789012:mySQSqueue", 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:myFunction", 
  last_modified: Time.parse("2016-11-21T19:49:20.006Z"), 
  last_processing_result: "No records processed", 
  maximum_record_age_in_seconds: 604800, 
  maximum_retry_attempts: 10000, 
  state: "Creating", 
  state_transition_reason: "User action", 
  uuid: "14e0db71-xmpl-4eb5-b481-8945cf9d10c2", 
}

Request syntax with placeholder values


resp = client.get_event_source_mapping({
  uuid: "UUIDString", # required
})

Response structure


resp.uuid #=> String
resp.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.starting_position_timestamp #=> Time
resp.batch_size #=> Integer
resp.maximum_batching_window_in_seconds #=> Integer
resp.parallelization_factor #=> Integer
resp.event_source_arn #=> String
resp.filter_criteria.filters #=> Array
resp.filter_criteria.filters[0].pattern #=> String
resp.filter_criteria_error.error_code #=> String
resp.filter_criteria_error.message #=> String
resp.kms_key_arn #=> String
resp.metrics_config.metrics #=> Array
resp.metrics_config.metrics[0] #=> String, one of "EventCount", "ErrorCount", "KafkaMetrics"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.scaling_config.maximum_concurrency #=> Integer
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String
resp.topics #=> Array
resp.topics[0] #=> String
resp.queues #=> Array
resp.queues[0] #=> String
resp.source_access_configurations #=> Array
resp.source_access_configurations[0].type #=> String, one of "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH", "OAUTHBEARER_SCOPE", "OAUTHBEARER_AUDIENCE", "OAUTHBEARER_LOGICAL_CLUSTER", "OAUTHBEARER_IDENTITY_POOL", "IAM_AUTH", "IAM_OAUTHBEARER_AUTH"
resp.source_access_configurations[0].uri #=> String
resp.self_managed_event_source.endpoints #=> Hash
resp.self_managed_event_source.endpoints["EndPointType"] #=> Array
resp.self_managed_event_source.endpoints["EndPointType"][0] #=> String
resp.maximum_record_age_in_seconds #=> Integer
resp.bisect_batch_on_function_error #=> Boolean
resp.maximum_retry_attempts #=> Integer
resp.tumbling_window_in_seconds #=> Integer
resp.function_response_types #=> Array
resp.function_response_types[0] #=> String, one of "ReportBatchItemFailures"
resp.amazon_managed_kafka_event_source_config.consumer_group_id #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumer_group_id #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumption_mode #=> String, one of "Stream", "Queue"
resp.document_db_event_source_config.database_name #=> String
resp.document_db_event_source_config.collection_name #=> String
resp.document_db_event_source_config.full_document #=> String, one of "UpdateLookup", "Default"
resp.event_source_mapping_arn #=> String
resp.provisioned_poller_config.minimum_pollers #=> Integer
resp.provisioned_poller_config.maximum_pollers #=> Integer
resp.provisioned_poller_config.poller_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The identifier of the event source mapping.

Returns:

See Also:



3788
3789
3790
3791
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3788

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

#get_function(params = {}) ⇒ Types::GetFunctionResponse

Returns information about a Lambda Event Function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

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

  • function_active_v2
  • function_exists
  • function_updated_v2

Examples:

Example: To get a Lambda function


# The following example returns code and configuration details for version 1 of a function named my-function.

resp = client.get_function({
  function_name: "my-function", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  code: {
    location: "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...", 
    repository_type: "S3", 
  }, 
  configuration: {
    code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
    code_size: 5797206, 
    description: "Process image objects from Amazon S3.", 
    durable_config: {
      execution_timeout: 31622400, 
      retention_period_in_days: 30, 
    }, 
    environment: {
      variables: {
        "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
        "PREFIX" => "inbound", 
      }, 
    }, 
    function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
    function_name: "my-function", 
    handler: "index.handler", 
    kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
    last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
    last_update_status: "Successful", 
    memory_size: 256, 
    revision_id: "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", 
    role: "arn:aws:iam::123456789012:role/lambda-role", 
    runtime: "nodejs12.x", 
    state: "Active", 
    timeout: 15, 
    tracing_config: {
      mode: "Active", 
    }, 
    version: "$LATEST", 
  }, 
  tags: {
    "DEPARTMENT" => "Assets", 
  }, 
}

Request syntax with placeholder values


resp = client.get_function({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


resp.configuration.function_name #=> String
resp.configuration.function_arn #=> String
resp.configuration.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.configuration.role #=> String
resp.configuration.handler #=> String
resp.configuration.code_size #=> Integer
resp.configuration.description #=> String
resp.configuration.timeout #=> Integer
resp.configuration.memory_size #=> Integer
resp.configuration.last_modified #=> Time
resp.configuration.code_sha_256 #=> String
resp.configuration.version #=> String
resp.configuration.vpc_config.subnet_ids #=> Array
resp.configuration.vpc_config.subnet_ids[0] #=> String
resp.configuration.vpc_config.security_group_ids #=> Array
resp.configuration.vpc_config.security_group_ids[0] #=> String
resp.configuration.vpc_config.vpc_id #=> String
resp.configuration.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.configuration.dead_letter_config.target_arn #=> String
resp.configuration.environment.variables #=> Hash
resp.configuration.environment.variables["EnvironmentVariableName"] #=> String
resp.configuration.environment.error.error_code #=> String
resp.configuration.environment.error.message #=> String
resp.configuration.kms_key_arn #=> String
resp.configuration.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.configuration.master_arn #=> String
resp.configuration.revision_id #=> String
resp.configuration.layers #=> Array
resp.configuration.layers[0].arn #=> String
resp.configuration.layers[0].code_size #=> Integer
resp.configuration.layers[0].signing_profile_version_arn #=> String
resp.configuration.layers[0].signing_job_arn #=> String
resp.configuration.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.configuration.state_reason #=> String
resp.configuration.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.configuration.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.configuration.last_update_status_reason #=> String
resp.configuration.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.configuration.file_system_configs #=> Array
resp.configuration.file_system_configs[0].arn #=> String
resp.configuration.file_system_configs[0].local_mount_path #=> String
resp.configuration.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.configuration.signing_profile_version_arn #=> String
resp.configuration.signing_job_arn #=> String
resp.configuration.package_type #=> String, one of "Zip", "Image"
resp.configuration.image_config_response.image_config.entry_point #=> Array
resp.configuration.image_config_response.image_config.entry_point[0] #=> String
resp.configuration.image_config_response.image_config.command #=> Array
resp.configuration.image_config_response.image_config.command[0] #=> String
resp.configuration.image_config_response.image_config.working_directory #=> String
resp.configuration.image_config_response.error.error_code #=> String
resp.configuration.image_config_response.error.message #=> String
resp.configuration.architectures #=> Array
resp.configuration.architectures[0] #=> String, one of "x86_64", "arm64"
resp.configuration.ephemeral_storage.size #=> Integer
resp.configuration.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.configuration.snap_start.optimization_status #=> String, one of "On", "Off"
resp.configuration.runtime_version_config.runtime_version_arn #=> String
resp.configuration.runtime_version_config.error.error_code #=> String
resp.configuration.runtime_version_config.error.message #=> String
resp.configuration.logging_config.log_format #=> String, one of "JSON", "Text"
resp.configuration.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.configuration.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.configuration.logging_config.log_group #=> String
resp.configuration.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.configuration.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.configuration.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.configuration.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.configuration.config_sha_256 #=> String
resp.configuration.durable_config.kms_key_arn #=> String
resp.configuration.durable_config.retention_period_in_days #=> Integer
resp.configuration.durable_config.execution_timeout #=> Integer
resp.code.repository_type #=> String
resp.code.location #=> String
resp.code.image_uri #=> String
resp.code.resolved_image_uri #=> String
resp.code.resolved_s3_object.s3_bucket #=> String
resp.code.resolved_s3_object.s3_key #=> String
resp.code.resolved_s3_object.s3_object_version #=> String
resp.code.source_kms_key_arn #=> String
resp.code.error.error_code #=> String
resp.code.error.message #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.tags_error.error_code #=> String
resp.tags_error.message #=> String
resp.concurrency.reserved_concurrent_executions #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    Specify a version or alias to get details about a published version of the function.

Returns:

See Also:



3987
3988
3989
3990
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 3987

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

#get_function_code_signing_config(params = {}) ⇒ Types::GetFunctionCodeSigningConfigResponse

Returns the code signing configuration for the specified function.

Examples:

Request syntax with placeholder values


resp = client.get_function_code_signing_config({
  function_name: "NamespacedFunctionName", # required
})

Response structure


resp.code_signing_config_arn #=> String
resp.function_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

    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:



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

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

#get_function_concurrency(params = {}) ⇒ Types::GetFunctionConcurrencyResponse

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

Examples:

Example: To get the reserved concurrency setting for a function


# The following example returns the reserved concurrency setting for a function named my-function.

resp = client.get_function_concurrency({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  reserved_concurrent_executions: 250, 
}

Request syntax with placeholder values


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

Response structure


resp.reserved_concurrent_executions #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    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:



4085
4086
4087
4088
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4085

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

#get_function_configuration(params = {}) ⇒ Types::FunctionConfiguration

Returns the version-specific settings of a Lambda Event Function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

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

  • function_active
  • function_updated
  • published_version_active

Examples:

Example: To get a Lambda function's event source mapping


# The following example returns and configuration details for version 1 of a function named my-function.

resp = client.get_function_configuration({
  function_name: "my-function", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
  code_size: 5797206, 
  description: "Process image objects from Amazon S3.", 
  durable_config: {
    execution_timeout: 31622400, 
    retention_period_in_days: 30, 
  }, 
  environment: {
    variables: {
      "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
      "PREFIX" => "inbound", 
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  function_name: "my-function", 
  handler: "index.handler", 
  kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
  last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
  last_update_status: "Successful", 
  memory_size: 256, 
  revision_id: "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  state: "Active", 
  timeout: 15, 
  tracing_config: {
    mode: "Active", 
  }, 
  version: "$LATEST", 
}

Request syntax with placeholder values


resp = client.get_function_configuration({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String
resp.layers #=> Array
resp.layers[0].arn #=> String
resp.layers[0].code_size #=> Integer
resp.layers[0].signing_profile_version_arn #=> String
resp.layers[0].signing_job_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.state_reason #=> String
resp.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.last_update_status_reason #=> String
resp.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.file_system_configs #=> Array
resp.file_system_configs[0].arn #=> String
resp.file_system_configs[0].local_mount_path #=> String
resp.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.signing_profile_version_arn #=> String
resp.signing_job_arn #=> String
resp.package_type #=> String, one of "Zip", "Image"
resp.image_config_response.image_config.entry_point #=> Array
resp.image_config_response.image_config.entry_point[0] #=> String
resp.image_config_response.image_config.command #=> Array
resp.image_config_response.image_config.command[0] #=> String
resp.image_config_response.image_config.working_directory #=> String
resp.image_config_response.error.error_code #=> String
resp.image_config_response.error.message #=> String
resp.architectures #=> Array
resp.architectures[0] #=> String, one of "x86_64", "arm64"
resp.ephemeral_storage.size #=> Integer
resp.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.snap_start.optimization_status #=> String, one of "On", "Off"
resp.runtime_version_config.runtime_version_arn #=> String
resp.runtime_version_config.error.error_code #=> String
resp.runtime_version_config.error.message #=> String
resp.logging_config.log_format #=> String, one of "JSON", "Text"
resp.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.logging_config.log_group #=> String
resp.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.config_sha_256 #=> String
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    Specify a version or alias to get details about a published version of the function.

Returns:

See Also:



4298
4299
4300
4301
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4298

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

#get_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Examples:

Example: To get an asynchronous invocation configuration


# The following example returns the asynchronous invocation configuration for the BLUE alias of a function named
# my-function.

resp = client.get_function_event_invoke_config({
  function_name: "my-function", 
  qualifier: "BLUE", 
})

resp.to_h outputs the following:
{
  destination_config: {
    on_failure: {
      destination: "arn:aws:sqs:us-east-2:123456789012:failed-invocations", 
    }, 
    on_success: {
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", 
  last_modified: Time.parse("2016-11-21T19:49:20.006Z"), 
  maximum_event_age_in_seconds: 3600, 
  maximum_retry_attempts: 0, 
}

Request syntax with placeholder values


resp = client.get_function_event_invoke_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


resp.last_modified #=> Time
resp.function_arn #=> String
resp.maximum_retry_attempts #=> Integer
resp.maximum_event_age_in_seconds #=> Integer
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    A version number or alias name.

Returns:

See Also:



4383
4384
4385
4386
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4383

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

#get_function_recursion_config(params = {}) ⇒ Types::GetFunctionRecursionConfigResponse

Returns your function's recursive loop detection configuration.

Examples:

Request syntax with placeholder values


resp = client.get_function_recursion_config({
  function_name: "UnqualifiedFunctionName", # required
})

Response structure


resp.recursive_loop #=> String, one of "Allow", "Terminate"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the function.

Returns:

See Also:



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

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

#get_function_scaling_config(params = {}) ⇒ Types::GetFunctionScalingConfigResponse

Retrieves the scaling configuration for a Lambda Managed Instances function.

Examples:

Request syntax with placeholder values


resp = client.get_function_scaling_config({
  function_name: "UnqualifiedFunctionName", # required
  qualifier: "PublishedFunctionQualifier", # required
})

Response structure


resp.function_arn #=> String
resp.applied_function_scaling_config.min_execution_environments #=> Integer
resp.applied_function_scaling_config.max_execution_environments #=> Integer
resp.requested_function_scaling_config.min_execution_environments #=> Integer
resp.requested_function_scaling_config.max_execution_environments #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

  • :qualifier (required, String) —

    Specify a version or alias to get the scaling configuration for a published version of the function.

Returns:

See Also:



4455
4456
4457
4458
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4455

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

#get_function_url_config(params = {}) ⇒ Types::GetFunctionUrlConfigResponse

Returns details about a Lambda function URL.

Examples:

Request syntax with placeholder values


resp = client.get_function_url_config({
  function_name: "FunctionUrlFunctionName", # required
  qualifier: "FunctionUrlQualifier",
})

Response structure


resp.function_url #=> String
resp.function_arn #=> String
resp.auth_type #=> String, one of "NONE", "AWS_IAM"
resp.cors.allow_credentials #=> Boolean
resp.cors.allow_headers #=> Array
resp.cors.allow_headers[0] #=> String
resp.cors.allow_methods #=> Array
resp.cors.allow_methods[0] #=> String
resp.cors.allow_origins #=> Array
resp.cors.allow_origins[0] #=> String
resp.cors.expose_headers #=> Array
resp.cors.expose_headers[0] #=> String
resp.cors.max_age #=> Integer
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.invoke_mode #=> String, one of "BUFFERED", "RESPONSE_STREAM"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    The alias name.

Returns:

See Also:



4520
4521
4522
4523
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4520

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

#get_layer_version(params = {}) ⇒ Types::GetLayerVersionResponse

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

Examples:

Example: To get information about a Lambda layer version


# The following example returns information for version 1 of a layer named my-layer.

resp = client.get_layer_version({
  layer_name: "my-layer", 
  version_number: 1, 
})

resp.to_h outputs the following:
{
  compatible_runtimes: [
    "python3.6", 
    "python3.7", 
  ], 
  content: {
    code_sha_256: "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", 
    code_size: 169, 
    location: "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", 
  }, 
  created_date: Time.parse("2018-11-14T23:03:52.894+0000"), 
  description: "My Python layer", 
  layer_arn: "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", 
  layer_version_arn: "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", 
  license_info: "MIT", 
  version: 1, 
}

Request syntax with placeholder values


resp = client.get_layer_version({
  layer_name: "LayerName", # required
  version_number: 1, # required
})

Response structure


resp.content.location #=> String
resp.content.code_sha_256 #=> String
resp.content.code_size #=> Integer
resp.content.signing_profile_version_arn #=> String
resp.content.signing_job_arn #=> String
resp.content.resolved_s3_object.s3_bucket #=> String
resp.content.resolved_s3_object.s3_key #=> String
resp.content.resolved_s3_object.s3_object_version #=> String
resp.layer_arn #=> String
resp.layer_version_arn #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> Integer
resp.compatible_architectures #=> Array
resp.compatible_architectures[0] #=> String, one of "x86_64", "arm64"
resp.compatible_runtimes #=> Array
resp.compatible_runtimes[0] #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.license_info #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :version_number (required, Integer) —

    The version number.

Returns:

See Also:



4611
4612
4613
4614
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4611

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

#get_layer_version_by_arn(params = {}) ⇒ Types::GetLayerVersionResponse

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

Examples:

Example: To get information about a Lambda layer version


# The following example returns information about the layer version with the specified Amazon Resource Name (ARN).

resp = client.get_layer_version_by_arn({
  arn: "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3", 
})

resp.to_h outputs the following:
{
  compatible_runtimes: [
    "python3.8", 
  ], 
  content: {
    code_sha_256: "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=", 
    code_size: 9529009, 
    location: "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf...", 
  }, 
  created_date: Time.parse("2020-03-31T00:35:18.949+0000"), 
  description: "Dependencies for the blank-python sample app.", 
  layer_arn: "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib", 
  layer_version_arn: "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3", 
  version: 3, 
}

Request syntax with placeholder values


resp = client.get_layer_version_by_arn({
  arn: "LayerVersionArn", # required
})

Response structure


resp.content.location #=> String
resp.content.code_sha_256 #=> String
resp.content.code_size #=> Integer
resp.content.signing_profile_version_arn #=> String
resp.content.signing_job_arn #=> String
resp.content.resolved_s3_object.s3_bucket #=> String
resp.content.resolved_s3_object.s3_key #=> String
resp.content.resolved_s3_object.s3_object_version #=> String
resp.layer_arn #=> String
resp.layer_version_arn #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> Integer
resp.compatible_architectures #=> Array
resp.compatible_architectures[0] #=> String, one of "x86_64", "arm64"
resp.compatible_runtimes #=> Array
resp.compatible_runtimes[0] #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.license_info #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the layer version.

Returns:

See Also:



4695
4696
4697
4698
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4695

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

#get_layer_version_policy(params = {}) ⇒ Types::GetLayerVersionPolicyResponse

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Examples:

Request syntax with placeholder values


resp = client.get_layer_version_policy({
  layer_name: "LayerName", # required
  version_number: 1, # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :version_number (required, Integer) —

    The version number.

Returns:

See Also:



4734
4735
4736
4737
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4734

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

#get_policy(params = {}) ⇒ Types::GetPolicyResponse

Returns the resource-based IAM policy for a function, version, or alias.

Examples:

Example: To retrieve a Lambda function policy


# The following example returns the resource-based policy for version 1 of a Lambda function named my-function.

resp = client.get_policy({
  function_name: "my-function", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  policy: "{\"Version\":\"2012-10-17\",\"Id\":\"default\",\"Statement\":[{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function:1\"}]}", 
  revision_id: "4843f2f6-7c59-4fda-b484-afd0bc0e22b8", 
}

Request syntax with placeholder values


resp = client.get_policy({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    Specify a version or alias to get the policy for that resource.

Returns:

See Also:



4803
4804
4805
4806
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4803

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

#get_provisioned_concurrency_config(params = {}) ⇒ Types::GetProvisionedConcurrencyConfigResponse

Retrieves the provisioned concurrency configuration for a function's alias or version.

Examples:

Example: To get a provisioned concurrency configuration


# The following example returns details for the provisioned concurrency configuration for the BLUE alias of the specified
# function.

resp = client.get_provisioned_concurrency_config({
  function_name: "my-function", 
  qualifier: "BLUE", 
})

resp.to_h outputs the following:
{
  allocated_provisioned_concurrent_executions: 100, 
  available_provisioned_concurrent_executions: 100, 
  last_modified: Time.parse("2019-12-31T20:28:49+0000"), 
  requested_provisioned_concurrent_executions: 100, 
  status: "READY", 
}

Example: To view a provisioned concurrency configuration


# The following example displays details for the provisioned concurrency configuration for the BLUE alias of the specified
# function.

resp = client.get_provisioned_concurrency_config({
  function_name: "my-function", 
  qualifier: "BLUE", 
})

resp.to_h outputs the following:
{
  allocated_provisioned_concurrent_executions: 100, 
  available_provisioned_concurrent_executions: 100, 
  last_modified: Time.parse("2019-12-31T20:28:49+0000"), 
  requested_provisioned_concurrent_executions: 100, 
  status: "READY", 
}

Request syntax with placeholder values


resp = client.get_provisioned_concurrency_config({
  function_name: "FunctionName", # required
  qualifier: "Qualifier", # required
})

Response structure


resp.requested_provisioned_concurrent_executions #=> Integer
resp.available_provisioned_concurrent_executions #=> Integer
resp.allocated_provisioned_concurrent_executions #=> Integer
resp.status #=> String, one of "IN_PROGRESS", "READY", "FAILED"
resp.status_reason #=> String
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (required, String) —

    The version number or alias name.

Returns:

See Also:



4897
4898
4899
4900
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4897

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

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

Retrieves the resource-based policy attached to a Lambda resource.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "PolicyResourceArn", # 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 Lambda resource you want to retrieve the policy for. You can use a qualified or an unqualified ARN. The value must be a complete ARN, and the operation does not accept wildcard characters.

Returns:

See Also:



4935
4936
4937
4938
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 4935

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

#get_runtime_management_config(params = {}) ⇒ Types::GetRuntimeManagementConfigResponse

Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.

Examples:

Request syntax with placeholder values


resp = client.get_runtime_management_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
})

Response structure


resp.update_runtime_on #=> String, one of "Auto", "Manual", "FunctionUpdate"
resp.function_arn #=> String
resp.runtime_version_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

Returns:

See Also:



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

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

#invoke(params = {}) ⇒ Types::InvocationResponse

Invokes a Lambda Event Function. You can invoke a function synchronously (and wait for the response), or asynchronously. By default, Lambda invokes your function synchronously (i.e. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Error handling and automatic retries in Lambda.

For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, quota errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if running the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might disconnect during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

Examples:

Example: To invoke a Lambda function


# The following example invokes version 1 of a function named my-function with an empty event payload.

resp = client.invoke({
  durable_execution_name: "myExecution", 
  function_name: "my-function", 
  invocation_type: "Event", 
  payload: "{}", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  payload: "200 SUCCESS", 
  status_code: 200, 
}

Example: To invoke a Lambda function asynchronously


# The following example invokes version 1 of a function named my-function asynchronously.

resp = client.invoke({
  function_name: "my-function", 
  invocation_type: "Event", 
  payload: "{}", 
  qualifier: "1", 
})

resp.to_h outputs the following:
{
  payload: "", 
  status_code: 202, 
}

Request syntax with placeholder values


resp = client.invoke({
  function_name: "NamespacedFunctionName", # required
  invocation_type: "Event", # accepts Event, RequestResponse, DryRun
  log_type: "None", # accepts None, Tail
  client_context: "String",
  durable_execution_name: "DurableExecutionName",
  payload: "data",
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  tenant_id: "TenantId",
})

Response structure


resp.status_code #=> Integer
resp.function_error #=> String
resp.log_result #=> String
resp.payload #=> String
resp.executed_version #=> String
resp.durable_execution_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :invocation_type (String) —

    Choose from the following options.

    • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

    • Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.

    • DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.

  • :log_type (String) —

    Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

  • :client_context (String) —

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. Lambda passes the ClientContext object to your function for synchronous invocations only.

  • :durable_execution_name (String) —

    A unique name for the durable execution. If you invoke a durable function using a name that already exists with the same payload, Lambda returns the existing execution instead of creating a duplicate. If the payload differs, Lambda returns a DurableExecutionAlreadyStartedException error.

    If not specified, Lambda generates a unique identifier automatically. For more information, see Execution names.

  • :payload (String, StringIO, File) —

    The JSON that you want to provide to your Lambda function as input. The maximum payload size is 6 MB for synchronous invocations and 1 MB for asynchronous invocations.

    You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

  • :qualifier (String) —

    Specify a version or alias to invoke a published version of the function.

  • :tenant_id (String) —

    The identifier of the tenant in a multi-tenant Lambda function.

Returns:

See Also:



5202
5203
5204
5205
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5202

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

#invoke_async(params = {}) ⇒ Types::InvokeAsyncResponse

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke.

If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.

Examples:

Example: To invoke a Lambda function asynchronously


# The following example invokes a Lambda function asynchronously

resp = client.invoke_async({
  function_name: "my-function", 
  invoke_args: "{}", 
})

resp.to_h outputs the following:
{
  status: 202, 
}

Request syntax with placeholder values


resp = client.invoke_async({
  function_name: "NamespacedFunctionName", # required
  invoke_args: "data", # required
})

Response structure


resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

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

    The JSON that you want to provide to your Lambda function as input.

Returns:

See Also:



5278
5279
5280
5281
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5278

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

#invoke_with_response_stream(params = {}) ⇒ Types::InvokeWithResponseStreamResponse

Configure your Lambda Event Functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.

This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts.

Examples:

EventStream Operation Example


# You can process the event once it arrives immediately, or wait until the
# full response is complete and iterate through the eventstream enumerator.

# To interact with event immediately, you need to register invoke_with_response_stream
# with callbacks. Callbacks can be registered for specific events or for all
# events, including error events.

# Callbacks can be passed into the `:event_stream_handler` option or within a
# block statement attached to the #invoke_with_response_stream call directly. Hybrid
# pattern of both is also supported.

# `:event_stream_handler` option takes in either a Proc object or
# Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent object.

# Usage pattern a): Callbacks with a block attached to #invoke_with_response_stream
# Example for registering callbacks for all event types and an error event
client.invoke_with_response_stream(
  # params input
) do |stream|
  stream.on_error_event do |event|
    # catch unmodeled error event in the stream
    raise event
    # => Aws::Errors::EventError
    # event.event_type => :error
    # event.error_code => String
    # event.error_message => String
  end

  stream.on_event do |event|
    # process all events arrive
    puts event.event_type
    # ...
  end
end

# Usage pattern b): Pass in `:event_stream_handler` for #invoke_with_response_stream
#  1) Create a Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent object
#  Example for registering callbacks with specific events

handler = Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent.new
handler.on_payload_chunk_event do |event|
  event # => Aws::Lambda::Types::PayloadChunk
end
handler.on_invoke_complete_event do |event|
  event # => Aws::Lambda::Types::InvokeComplete
end

client.invoke_with_response_stream(
  # params inputs
  event_stream_handler: handler
)

#  2) Use a Ruby Proc object
#  Example for registering callbacks with specific events
handler = Proc.new do |stream|
  stream.on_payload_chunk_event do |event|
    event # => Aws::Lambda::Types::PayloadChunk
  end
  stream.on_invoke_complete_event do |event|
    event # => Aws::Lambda::Types::InvokeComplete
  end
end

client.invoke_with_response_stream(
  # params inputs
  event_stream_handler: handler
)

#  Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent.new
handler.on_payload_chunk_event do |event|
  event # => Aws::Lambda::Types::PayloadChunk
end
handler.on_invoke_complete_event do |event|
  event # => Aws::Lambda::Types::InvokeComplete
end

client.invoke_with_response_stream(
  # params input
  event_stream_handler: handler
) do |stream|
  stream.on_error_event do |event|
    # catch unmodeled error event in the stream
    raise event
    # => Aws::Errors::EventError
    # event.event_type => :error
    # event.error_code => String
    # event.error_message => String
  end
end

# You can also iterate through events after the response complete.
# Events are available at
resp.event_stream # => Enumerator
# For parameter input example, please refer to following request syntax.

Request syntax with placeholder values


resp = client.invoke_with_response_stream({
  function_name: "NamespacedFunctionName", # required
  log_type: "None", # accepts None, Tail
  client_context: "String",
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  payload: "data",
  tenant_id: "TenantId",
  invocation_type: "RequestResponse", # accepts RequestResponse, DryRun
})

Response structure


resp.status_code #=> Integer
resp.executed_version #=> String
# All events are available at resp.event_stream:
resp.event_stream #=> Enumerator
resp.event_stream.event_types #=> [:payload_chunk, :invoke_complete]

# For :payload_chunk event available at #on_payload_chunk_event callback and response eventstream enumerator:
event.payload #=> String

# For :invoke_complete event available at #on_invoke_complete_event callback and response eventstream enumerator:
event.error_code #=> String
event.error_details #=> String
event.log_result #=> String

resp.response_stream_content_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :log_type (String) —

    Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.

  • :client_context (String) —

    Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

  • :qualifier (String) —

    The alias name.

  • :payload (String, StringIO, File) —

    The JSON that you want to provide to your Lambda function as input.

    You can enter the JSON directly. For example, --payload '{ "key": "value" }'. You can also specify a file path. For example, --payload file://payload.json.

  • :tenant_id (String) —

    The identifier of the tenant in a multi-tenant Lambda function.

  • :invocation_type (String) —

    Use one of the following options:

    • RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.

    • DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.

Yields:

  • (event_stream_handler)

Returns:

See Also:



5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5483

def invoke_with_response_stream(params = {}, options = {}, &block)
  params = params.dup
  event_stream_handler = case handler = params.delete(:event_stream_handler)
    when EventStreams::InvokeWithResponseStreamResponseEvent then handler
    when Proc then EventStreams::InvokeWithResponseStreamResponseEvent.new.tap(&handler)
    when nil then EventStreams::InvokeWithResponseStreamResponseEvent.new
    else
      msg = "expected :event_stream_handler to be a block or "\
            "instance of Aws::Lambda::EventStreams::InvokeWithResponseStreamResponseEvent"\
            ", got `#{handler.inspect}` instead"
      raise ArgumentError, msg
    end

  yield(event_stream_handler) if block_given?

  req = build_request(:invoke_with_response_stream, params)

  req.context[:event_stream_handler] = event_stream_handler
  req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)

  req.send_request(options, &block)
end

#list_aliases(params = {}) ⇒ Types::ListAliasesResponse

Returns a list of aliases for a Lambda Event Function.

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

Examples:

Example: To list a function's aliases


# The following example returns a list of aliases for a function named my-function.

resp = client.list_aliases({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  aliases: [
    {
      alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", 
      description: "Production environment BLUE.", 
      function_version: "2", 
      name: "BLUE", 
      revision_id: "a410117f-xmpl-494e-8035-7e204bb7933b", 
      routing_config: {
        additional_version_weights: {
          "1" => 0.7, 
        }, 
      }, 
    }, 
    {
      alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", 
      description: "Production environment GREEN.", 
      function_version: "1", 
      name: "GREEN", 
      revision_id: "21d40116-xmpl-40ba-9360-3ea284da1bb5", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_aliases({
  function_name: "FunctionName", # required
  function_version: "VersionWithLatestPublished",
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.aliases #=> Array
resp.aliases[0].alias_arn #=> String
resp.aliases[0].name #=> String
resp.aliases[0].function_version #=> String
resp.aliases[0].description #=> String
resp.aliases[0].routing_config.additional_version_weights #=> Hash
resp.aliases[0].routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.aliases[0].revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :function_version (String) —

    Specify a function version to only list aliases that invoke that version.

  • :marker (String) —

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

  • :max_items (Integer) —

    Limit the number of aliases returned.

Returns:

See Also:



5604
5605
5606
5607
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5604

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

#list_capacity_providers(params = {}) ⇒ Types::ListCapacityProvidersResponse

Returns a list of capacity providers in your account.

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

Examples:

Request syntax with placeholder values


resp = client.list_capacity_providers({
  state: "Pending", # accepts Pending, Active, Failed, Deleting
  marker: "String",
  max_items: 1,
})

Response structure


resp.capacity_providers #=> Array
resp.capacity_providers[0].capacity_provider_arn #=> String
resp.capacity_providers[0].state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.capacity_providers[0].vpc_config.subnet_ids #=> Array
resp.capacity_providers[0].vpc_config.subnet_ids[0] #=> String
resp.capacity_providers[0].vpc_config.security_group_ids #=> Array
resp.capacity_providers[0].vpc_config.security_group_ids[0] #=> String
resp.capacity_providers[0].permissions_config.capacity_provider_operator_role_arn #=> String
resp.capacity_providers[0].instance_requirements.architectures #=> Array
resp.capacity_providers[0].instance_requirements.architectures[0] #=> String, one of "x86_64", "arm64"
resp.capacity_providers[0].instance_requirements.allowed_instance_types #=> Array
resp.capacity_providers[0].instance_requirements.allowed_instance_types[0] #=> String
resp.capacity_providers[0].instance_requirements.excluded_instance_types #=> Array
resp.capacity_providers[0].instance_requirements.excluded_instance_types[0] #=> String
resp.capacity_providers[0].capacity_provider_scaling_config.max_v_cpu_count #=> Integer
resp.capacity_providers[0].capacity_provider_scaling_config.scaling_mode #=> String, one of "Auto", "Manual"
resp.capacity_providers[0].capacity_provider_scaling_config.scaling_policies #=> Array
resp.capacity_providers[0].capacity_provider_scaling_config.scaling_policies[0].predefined_metric_type #=> String, one of "LambdaCapacityProviderAverageCPUUtilization"
resp.capacity_providers[0].capacity_provider_scaling_config.scaling_policies[0].target_value #=> Float
resp.capacity_providers[0].kms_key_arn #=> String
resp.capacity_providers[0].last_modified #=> Time
resp.capacity_providers[0].propagate_tags.mode #=> String, one of "None", "Explicit"
resp.capacity_providers[0].propagate_tags.explicit_tags #=> Hash
resp.capacity_providers[0].propagate_tags.explicit_tags["TagKey"] #=> String
resp.capacity_providers[0].telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.capacity_providers[0].telemetry_config.logging_config.log_group #=> String
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :state (String) —

    Filter capacity providers by their current state.

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of capacity providers to return.

Returns:

See Also:



5670
5671
5672
5673
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5670

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

#list_code_signing_configs(params = {}) ⇒ Types::ListCodeSigningConfigsResponse

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

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_code_signing_configs({
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.code_signing_configs #=> Array
resp.code_signing_configs[0].code_signing_config_id #=> String
resp.code_signing_configs[0].code_signing_config_arn #=> String
resp.code_signing_configs[0].description #=> String
resp.code_signing_configs[0].allowed_publishers.signing_profile_version_arns #=> Array
resp.code_signing_configs[0].allowed_publishers.signing_profile_version_arns[0] #=> String
resp.code_signing_configs[0].code_signing_policies.untrusted_artifact_on_deployment #=> String, one of "Warn", "Enforce"
resp.code_signing_configs[0].last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :marker (String) —

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

  • :max_items (Integer) —

    Maximum number of items to return.

Returns:

See Also:



5720
5721
5722
5723
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5720

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

#list_durable_executions_by_function(params = {}) ⇒ Types::ListDurableExecutionsByFunctionResponse

Returns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.

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_durable_executions_by_function({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  durable_execution_name: "DurableExecutionName",
  statuses: ["RUNNING"], # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED
  started_after: Time.now,
  started_before: Time.now,
  reverse_order: false,
  marker: "String",
  max_items: 1,
})

Response structure


resp.durable_executions #=> Array
resp.durable_executions[0].durable_execution_arn #=> String
resp.durable_executions[0].durable_execution_name #=> String
resp.durable_executions[0].function_arn #=> String
resp.durable_executions[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "STOPPED"
resp.durable_executions[0].start_timestamp #=> Time
resp.durable_executions[0].end_timestamp #=> Time
resp.durable_executions[0].kms_key_arn #=> String
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function. You can specify a function name, a partial ARN, or a full ARN.

  • :qualifier (String) —

    The function version to filter executions by. If you don't specify a qualifier, this operation returns executions across all versions of the Lambda function.

  • :durable_execution_name (String) —

    Filter executions by name. Only executions with names that matches this string are returned.

  • :statuses (Array<String>) —

    Filter executions by status. Valid values: RUNNING, SUCCEEDED, FAILED, TIMED_OUT, STOPPED.

  • :started_after (Time, DateTime, Date, Integer, String) —

    Filter executions that started after this timestamp (ISO 8601 format).

  • :started_before (Time, DateTime, Date, Integer, String) —

    Filter executions that started before this timestamp (ISO 8601 format).

  • :reverse_order (Boolean) —

    Set to true to return results in chronological order (oldest first). Default is false.

  • :marker (String) —

    Pagination token from a previous request to continue retrieving results.

  • :max_items (Integer) —

    Maximum number of executions to return (1-1000). Default is 100.

Returns:

See Also:



5805
5806
5807
5808
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5805

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

#list_event_source_mappings(params = {}) ⇒ Types::ListEventSourceMappingsResponse

Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.

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

Examples:

Example: To list the event source mappings for a function


# The following example returns a list of the event source mappings for a function named my-function.

resp = client.list_event_source_mappings({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  event_source_mappings: [
    {
      batch_size: 5, 
      event_source_arn: "arn:aws:sqs:us-west-2:123456789012:mySQSqueue", 
      function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
      last_modified: Time.parse(1569284520.333), 
      state: "Enabled", 
      state_transition_reason: "USER_INITIATED", 
      uuid: "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_event_source_mappings({
  event_source_arn: "Arn",
  function_name: "NamespacedFunctionName",
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.event_source_mappings #=> Array
resp.event_source_mappings[0].uuid #=> String
resp.event_source_mappings[0].starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.event_source_mappings[0].starting_position_timestamp #=> Time
resp.event_source_mappings[0].batch_size #=> Integer
resp.event_source_mappings[0].maximum_batching_window_in_seconds #=> Integer
resp.event_source_mappings[0].parallelization_factor #=> Integer
resp.event_source_mappings[0].event_source_arn #=> String
resp.event_source_mappings[0].filter_criteria.filters #=> Array
resp.event_source_mappings[0].filter_criteria.filters[0].pattern #=> String
resp.event_source_mappings[0].filter_criteria_error.error_code #=> String
resp.event_source_mappings[0].filter_criteria_error.message #=> String
resp.event_source_mappings[0].kms_key_arn #=> String
resp.event_source_mappings[0].metrics_config.metrics #=> Array
resp.event_source_mappings[0].metrics_config.metrics[0] #=> String, one of "EventCount", "ErrorCount", "KafkaMetrics"
resp.event_source_mappings[0].logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.event_source_mappings[0].scaling_config.maximum_concurrency #=> Integer
resp.event_source_mappings[0].function_arn #=> String
resp.event_source_mappings[0].last_modified #=> Time
resp.event_source_mappings[0].last_processing_result #=> String
resp.event_source_mappings[0].state #=> String
resp.event_source_mappings[0].state_transition_reason #=> String
resp.event_source_mappings[0].destination_config.on_success.destination #=> String
resp.event_source_mappings[0].destination_config.on_failure.destination #=> String
resp.event_source_mappings[0].topics #=> Array
resp.event_source_mappings[0].topics[0] #=> String
resp.event_source_mappings[0].queues #=> Array
resp.event_source_mappings[0].queues[0] #=> String
resp.event_source_mappings[0].source_access_configurations #=> Array
resp.event_source_mappings[0].source_access_configurations[0].type #=> String, one of "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH", "OAUTHBEARER_SCOPE", "OAUTHBEARER_AUDIENCE", "OAUTHBEARER_LOGICAL_CLUSTER", "OAUTHBEARER_IDENTITY_POOL", "IAM_AUTH", "IAM_OAUTHBEARER_AUTH"
resp.event_source_mappings[0].source_access_configurations[0].uri #=> String
resp.event_source_mappings[0].self_managed_event_source.endpoints #=> Hash
resp.event_source_mappings[0].self_managed_event_source.endpoints["EndPointType"] #=> Array
resp.event_source_mappings[0].self_managed_event_source.endpoints["EndPointType"][0] #=> String
resp.event_source_mappings[0].maximum_record_age_in_seconds #=> Integer
resp.event_source_mappings[0].bisect_batch_on_function_error #=> Boolean
resp.event_source_mappings[0].maximum_retry_attempts #=> Integer
resp.event_source_mappings[0].tumbling_window_in_seconds #=> Integer
resp.event_source_mappings[0].function_response_types #=> Array
resp.event_source_mappings[0].function_response_types[0] #=> String, one of "ReportBatchItemFailures"
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.consumer_group_id #=> String
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.event_source_mappings[0].amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.event_source_mappings[0].self_managed_kafka_event_source_config.consumer_group_id #=> String
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.event_source_mappings[0].self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.event_source_mappings[0].self_managed_kafka_event_source_config.consumption_mode #=> String, one of "Stream", "Queue"
resp.event_source_mappings[0].document_db_event_source_config.database_name #=> String
resp.event_source_mappings[0].document_db_event_source_config.collection_name #=> String
resp.event_source_mappings[0].document_db_event_source_config.full_document #=> String, one of "UpdateLookup", "Default"
resp.event_source_mappings[0].event_source_mapping_arn #=> String
resp.event_source_mappings[0].provisioned_poller_config.minimum_pollers #=> Integer
resp.event_source_mappings[0].provisioned_poller_config.maximum_pollers #=> Integer
resp.event_source_mappings[0].provisioned_poller_config.poller_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_source_arn (String) —

    The Amazon Resource Name (ARN) of the event source.

    • Amazon Kinesis – The ARN of the data stream or a stream consumer.

    • Amazon DynamoDB Streams – The ARN of the stream.

    • Amazon Simple Queue Service – The ARN of the queue.

    • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

    • Amazon MQ – The ARN of the broker.

    • Amazon DocumentDB – The ARN of the DocumentDB change stream.

  • :function_name (String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – MyFunction.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    • Partial ARN – 123456789012:function:MyFunction.

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

  • :marker (String) —

    A pagination token returned by a previous call.

  • :max_items (Integer) —

    The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.

Returns:

See Also:



5973
5974
5975
5976
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 5973

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

#list_function_event_invoke_configs(params = {}) ⇒ Types::ListFunctionEventInvokeConfigsResponse

Retrieves a list of configurations for asynchronous invocation for a Lambda Event Function. To retrieve more configurations, use the Marker parameter.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

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

Examples:

Example: To view a list of asynchronous invocation configurations


# The following example returns a list of asynchronous invocation configurations for a function named my-function.

resp = client.list_function_event_invoke_configs({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  function_event_invoke_configs: [
    {
      function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", 
      last_modified: Time.parse(1577824406.719), 
      maximum_event_age_in_seconds: 1800, 
      maximum_retry_attempts: 2, 
    }, 
    {
      function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", 
      last_modified: Time.parse(1577824396.653), 
      maximum_event_age_in_seconds: 3600, 
      maximum_retry_attempts: 0, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_function_event_invoke_configs({
  function_name: "NamespacedFunctionName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.function_event_invoke_configs #=> Array
resp.function_event_invoke_configs[0].last_modified #=> Time
resp.function_event_invoke_configs[0].function_arn #=> String
resp.function_event_invoke_configs[0].maximum_retry_attempts #=> Integer
resp.function_event_invoke_configs[0].maximum_event_age_in_seconds #=> Integer
resp.function_event_invoke_configs[0].destination_config.on_success.destination #=> String
resp.function_event_invoke_configs[0].destination_config.on_failure.destination #=> String
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - my-function.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

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

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of configurations to return.

Returns:

See Also:



6064
6065
6066
6067
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6064

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

#list_function_url_configs(params = {}) ⇒ Types::ListFunctionUrlConfigsResponse

Returns a list of Lambda function URLs for the specified function.

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_function_url_configs({
  function_name: "FunctionUrlFunctionName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.function_url_configs #=> Array
resp.function_url_configs[0].function_url #=> String
resp.function_url_configs[0].function_arn #=> String
resp.function_url_configs[0].creation_time #=> Time
resp.function_url_configs[0].last_modified_time #=> Time
resp.function_url_configs[0].cors.allow_credentials #=> Boolean
resp.function_url_configs[0].cors.allow_headers #=> Array
resp.function_url_configs[0].cors.allow_headers[0] #=> String
resp.function_url_configs[0].cors.allow_methods #=> Array
resp.function_url_configs[0].cors.allow_methods[0] #=> String
resp.function_url_configs[0].cors.allow_origins #=> Array
resp.function_url_configs[0].cors.allow_origins[0] #=> String
resp.function_url_configs[0].cors.expose_headers #=> Array
resp.function_url_configs[0].cors.expose_headers[0] #=> String
resp.function_url_configs[0].cors.max_age #=> Integer
resp.function_url_configs[0].auth_type #=> String, one of "NONE", "AWS_IAM"
resp.function_url_configs[0].invoke_mode #=> String, one of "BUFFERED", "RESPONSE_STREAM"
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.

Returns:

See Also:



6135
6136
6137
6138
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6135

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

#list_function_versions_by_capacity_provider(params = {}) ⇒ Types::ListFunctionVersionsByCapacityProviderResponse

Returns a list of function versions that are configured to use a specific capacity provider.

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_function_versions_by_capacity_provider({
  capacity_provider_name: "CapacityProviderName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.capacity_provider_arn #=> String
resp.function_versions #=> Array
resp.function_versions[0].function_arn #=> String
resp.function_versions[0].state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_provider_name (required, String) —

    The name of the capacity provider to list function versions for.

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of function versions to return in the response.

Returns:

See Also:



6181
6182
6183
6184
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6181

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

#list_functions(params = {}) ⇒ Types::ListFunctionsResponse

Returns a list of Lambda Event Functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.

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

Examples:

Example: To get a list of Lambda functions


# This operation returns a list of Lambda functions.

resp = client.list_functions({
})

resp.to_h outputs the following:
{
  functions: [
    {
      code_sha_256: "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", 
      code_size: 294, 
      description: "", 
      function_arn: "arn:aws:lambda:us-west-2:123456789012:function:helloworld", 
      function_name: "helloworld", 
      handler: "helloworld.handler", 
      last_modified: Time.parse("2019-09-23T18:32:33.857+0000"), 
      memory_size: 128, 
      revision_id: "1718e831-badf-4253-9518-d0644210af7b", 
      role: "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", 
      runtime: "nodejs10.x", 
      timeout: 3, 
      tracing_config: {
        mode: "PassThrough", 
      }, 
      version: "$LATEST", 
    }, 
    {
      code_sha_256: "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", 
      code_size: 266, 
      description: "", 
      durable_config: {
        execution_timeout: 31622400, 
        retention_period_in_days: 30, 
      }, 
      function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
      function_name: "my-function", 
      handler: "index.handler", 
      last_modified: Time.parse("2019-10-01T16:47:28.490+0000"), 
      memory_size: 256, 
      revision_id: "93017fc9-59cb-41dc-901b-4845ce4bf668", 
      role: "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", 
      runtime: "nodejs10.x", 
      timeout: 3, 
      tracing_config: {
        mode: "PassThrough", 
      }, 
      version: "$LATEST", 
      vpc_config: {
        security_group_ids: [
        ], 
        subnet_ids: [
        ], 
        vpc_id: "", 
      }, 
    }, 
  ], 
  next_marker: "", 
}

Request syntax with placeholder values


resp = client.list_functions({
  master_region: "MasterRegion",
  function_version: "ALL", # accepts ALL
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.functions #=> Array
resp.functions[0].function_name #=> String
resp.functions[0].function_arn #=> String
resp.functions[0].runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.functions[0].role #=> String
resp.functions[0].handler #=> String
resp.functions[0].code_size #=> Integer
resp.functions[0].description #=> String
resp.functions[0].timeout #=> Integer
resp.functions[0].memory_size #=> Integer
resp.functions[0].last_modified #=> Time
resp.functions[0].code_sha_256 #=> String
resp.functions[0].version #=> String
resp.functions[0].vpc_config.subnet_ids #=> Array
resp.functions[0].vpc_config.subnet_ids[0] #=> String
resp.functions[0].vpc_config.security_group_ids #=> Array
resp.functions[0].vpc_config.security_group_ids[0] #=> String
resp.functions[0].vpc_config.vpc_id #=> String
resp.functions[0].vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.functions[0].dead_letter_config.target_arn #=> String
resp.functions[0].environment.variables #=> Hash
resp.functions[0].environment.variables["EnvironmentVariableName"] #=> String
resp.functions[0].environment.error.error_code #=> String
resp.functions[0].environment.error.message #=> String
resp.functions[0].kms_key_arn #=> String
resp.functions[0].tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.functions[0].master_arn #=> String
resp.functions[0].revision_id #=> String
resp.functions[0].layers #=> Array
resp.functions[0].layers[0].arn #=> String
resp.functions[0].layers[0].code_size #=> Integer
resp.functions[0].layers[0].signing_profile_version_arn #=> String
resp.functions[0].layers[0].signing_job_arn #=> String
resp.functions[0].state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.functions[0].state_reason #=> String
resp.functions[0].state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.functions[0].last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.functions[0].last_update_status_reason #=> String
resp.functions[0].last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.functions[0].file_system_configs #=> Array
resp.functions[0].file_system_configs[0].arn #=> String
resp.functions[0].file_system_configs[0].local_mount_path #=> String
resp.functions[0].file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.functions[0].signing_profile_version_arn #=> String
resp.functions[0].signing_job_arn #=> String
resp.functions[0].package_type #=> String, one of "Zip", "Image"
resp.functions[0].image_config_response.image_config.entry_point #=> Array
resp.functions[0].image_config_response.image_config.entry_point[0] #=> String
resp.functions[0].image_config_response.image_config.command #=> Array
resp.functions[0].image_config_response.image_config.command[0] #=> String
resp.functions[0].image_config_response.image_config.working_directory #=> String
resp.functions[0].image_config_response.error.error_code #=> String
resp.functions[0].image_config_response.error.message #=> String
resp.functions[0].architectures #=> Array
resp.functions[0].architectures[0] #=> String, one of "x86_64", "arm64"
resp.functions[0].ephemeral_storage.size #=> Integer
resp.functions[0].snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.functions[0].snap_start.optimization_status #=> String, one of "On", "Off"
resp.functions[0].runtime_version_config.runtime_version_arn #=> String
resp.functions[0].runtime_version_config.error.error_code #=> String
resp.functions[0].runtime_version_config.error.message #=> String
resp.functions[0].logging_config.log_format #=> String, one of "JSON", "Text"
resp.functions[0].logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.functions[0].logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.functions[0].logging_config.log_group #=> String
resp.functions[0].tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.functions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.functions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.functions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.functions[0].config_sha_256 #=> String
resp.functions[0].durable_config.kms_key_arn #=> String
resp.functions[0].durable_config.retention_period_in_days #=> Integer
resp.functions[0].durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :master_region (String) —

    For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.

  • :function_version (String) —

    Set to ALL to include entries for all published versions of each function.

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.

Returns:

See Also:



6379
6380
6381
6382
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6379

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

#list_functions_by_code_signing_config(params = {}) ⇒ Types::ListFunctionsByCodeSigningConfigResponse

List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.

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_functions_by_code_signing_config({
  code_signing_config_arn: "CodeSigningConfigArn", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.function_arns #=> Array
resp.function_arns[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :code_signing_config_arn (required, String) —

    The The Amazon Resource Name (ARN) of the code signing configuration.

  • :marker (String) —

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

  • :max_items (Integer) —

    Maximum number of items to return.

Returns:

See Also:



6423
6424
6425
6426
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6423

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

#list_layer_versions(params = {}) ⇒ Types::ListLayerVersionsResponse

Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.

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

Examples:

Example: To list versions of a layer


# The following example displays information about the versions for the layer named blank-java-lib

resp = client.list_layer_versions({
  layer_name: "blank-java-lib", 
})

resp.to_h outputs the following:
{
  layer_versions: [
    {
      compatible_runtimes: [
        "java8", 
      ], 
      created_date: Time.parse("2020-03-18T23:38:42.284+0000"), 
      description: "Dependencies for the blank-java sample app.", 
      layer_version_arn: "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:7", 
      version: 7, 
    }, 
    {
      compatible_runtimes: [
        "java8", 
      ], 
      created_date: Time.parse("2020-03-17T07:24:21.960+0000"), 
      description: "Dependencies for the blank-java sample app.", 
      layer_version_arn: "arn:aws:lambda:us-east-2:123456789012:layer:blank-java-lib:6", 
      version: 6, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_layer_versions({
  compatible_architecture: "x86_64", # accepts x86_64, arm64
  compatible_runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, nodejs10.x, nodejs12.x, nodejs14.x, nodejs16.x, nodejs18.x, nodejs20.x, nodejs22.x, nodejs24.x, java8, java8.al2, java11, java17, java21, java25, python2.7, python3.6, python3.7, python3.8, python3.9, python3.10, python3.11, python3.12, python3.13, python3.14, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, dotnet6, dotnet8, dotnet10, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, ruby3.2, ruby3.3, ruby3.4, ruby4.0, provided, provided.al2, provided.al2023, nodejs26.x, python3.15, java8.al2023, java11.al2023, java17.al2023
  layer_name: "LayerName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.layer_versions #=> Array
resp.layer_versions[0].layer_version_arn #=> String
resp.layer_versions[0].version #=> Integer
resp.layer_versions[0].description #=> String
resp.layer_versions[0].created_date #=> Time
resp.layer_versions[0].compatible_architectures #=> Array
resp.layer_versions[0].compatible_architectures[0] #=> String, one of "x86_64", "arm64"
resp.layer_versions[0].compatible_runtimes #=> Array
resp.layer_versions[0].compatible_runtimes[0] #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.layer_versions[0].license_info #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :compatible_architecture (String) —

    The compatible instruction set architecture.

  • :compatible_runtime (String) —

    A runtime identifier.

    The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

    For a list of all currently supported runtimes, see Supported runtimes.

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :marker (String) —

    A pagination token returned by a previous call.

  • :max_items (Integer) —

    The maximum number of versions to return.

Returns:

See Also:



6537
6538
6539
6540
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6537

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

#list_layers(params = {}) ⇒ Types::ListLayersResponse

Lists Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture.

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

Examples:

Example: To list the layers that are compatible with your function's runtime


# The following example returns information about layers that are compatible with the Python 3.7 runtime.

resp = client.list_layers({
  compatible_runtime: "python3.7", 
})

resp.to_h outputs the following:
{
  layers: [
    {
      latest_matching_version: {
        compatible_runtimes: [
          "python3.6", 
          "python3.7", 
        ], 
        created_date: Time.parse("2018-11-15T00:37:46.592+0000"), 
        description: "My layer", 
        layer_version_arn: "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", 
        version: 2, 
      }, 
      layer_arn: "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", 
      layer_name: "my-layer", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_layers({
  compatible_architecture: "x86_64", # accepts x86_64, arm64
  compatible_runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, nodejs10.x, nodejs12.x, nodejs14.x, nodejs16.x, nodejs18.x, nodejs20.x, nodejs22.x, nodejs24.x, java8, java8.al2, java11, java17, java21, java25, python2.7, python3.6, python3.7, python3.8, python3.9, python3.10, python3.11, python3.12, python3.13, python3.14, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, dotnet6, dotnet8, dotnet10, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, ruby3.2, ruby3.3, ruby3.4, ruby4.0, provided, provided.al2, provided.al2023, nodejs26.x, python3.15, java8.al2023, java11.al2023, java17.al2023
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.layers #=> Array
resp.layers[0].layer_name #=> String
resp.layers[0].layer_arn #=> String
resp.layers[0].latest_matching_version.layer_version_arn #=> String
resp.layers[0].latest_matching_version.version #=> Integer
resp.layers[0].latest_matching_version.description #=> String
resp.layers[0].latest_matching_version.created_date #=> Time
resp.layers[0].latest_matching_version.compatible_architectures #=> Array
resp.layers[0].latest_matching_version.compatible_architectures[0] #=> String, one of "x86_64", "arm64"
resp.layers[0].latest_matching_version.compatible_runtimes #=> Array
resp.layers[0].latest_matching_version.compatible_runtimes[0] #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.layers[0].latest_matching_version.license_info #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :compatible_architecture (String) —

    The compatible instruction set architecture.

  • :compatible_runtime (String) —

    A runtime identifier.

    The following list includes deprecated runtimes. For more information, see Runtime use after deprecation.

    For a list of all currently supported runtimes, see Supported runtimes.

  • :marker (String) —

    A pagination token returned by a previous call.

  • :max_items (Integer) —

    The maximum number of layers to return.

Returns:

See Also:



6646
6647
6648
6649
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6646

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

#list_provisioned_concurrency_configs(params = {}) ⇒ Types::ListProvisionedConcurrencyConfigsResponse

Retrieves a list of provisioned concurrency configurations for a function.

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

Examples:

Example: To get a list of provisioned concurrency configurations


# The following example returns a list of provisioned concurrency configurations for a function named my-function.

resp = client.list_provisioned_concurrency_configs({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  provisioned_concurrency_configs: [
    {
      allocated_provisioned_concurrent_executions: 100, 
      available_provisioned_concurrent_executions: 100, 
      function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN", 
      last_modified: Time.parse("2019-12-31T20:29:00+0000"), 
      requested_provisioned_concurrent_executions: 100, 
      status: "READY", 
    }, 
    {
      allocated_provisioned_concurrent_executions: 100, 
      available_provisioned_concurrent_executions: 100, 
      function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE", 
      last_modified: Time.parse("2019-12-31T20:28:49+0000"), 
      requested_provisioned_concurrent_executions: 100, 
      status: "READY", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_provisioned_concurrency_configs({
  function_name: "FunctionName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.provisioned_concurrency_configs #=> Array
resp.provisioned_concurrency_configs[0].function_arn #=> String
resp.provisioned_concurrency_configs[0].requested_provisioned_concurrent_executions #=> Integer
resp.provisioned_concurrency_configs[0].available_provisioned_concurrent_executions #=> Integer
resp.provisioned_concurrency_configs[0].allocated_provisioned_concurrent_executions #=> Integer
resp.provisioned_concurrency_configs[0].status #=> String, one of "IN_PROGRESS", "READY", "FAILED"
resp.provisioned_concurrency_configs[0].status_reason #=> String
resp.provisioned_concurrency_configs[0].last_modified #=> Time
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :marker (String) —

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

  • :max_items (Integer) —

    Specify a number to limit the number of configurations returned.

Returns:

See Also:



6738
6739
6740
6741
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6738

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

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

Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.

Examples:

Example: To retrieve the list of tags for a Lambda function


# The following example displays the tags attached to the my-function Lambda function.

resp = client.list_tags({
  resource: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
})

resp.to_h outputs the following:
{
  tags: {
    "Category" => "Web Tools", 
    "Department" => "Sales", 
  }, 
}

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The resource's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to function aliases or versions.

Returns:

See Also:



6791
6792
6793
6794
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6791

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

#list_versions_by_function(params = {}) ⇒ Types::ListVersionsByFunctionResponse

Returns a list of versions of a Lambda Event Function, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

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

Examples:

Example: To list versions of a function


# The following example returns a list of versions of a function named my-function

resp = client.list_versions_by_function({
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  versions: [
    {
      code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
      code_size: 5797206, 
      description: "Process image objects from Amazon S3.", 
      durable_config: {
        execution_timeout: 31622400, 
        retention_period_in_days: 30, 
      }, 
      environment: {
        variables: {
          "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
          "PREFIX" => "inbound", 
        }, 
      }, 
      function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
      function_name: "my-function", 
      handler: "index.handler", 
      kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
      last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
      memory_size: 256, 
      revision_id: "850ca006-2d98-4ff4-86db-8766e9d32fe9", 
      role: "arn:aws:iam::123456789012:role/lambda-role", 
      runtime: "nodejs12.x", 
      timeout: 15, 
      tracing_config: {
        mode: "Active", 
      }, 
      version: "$LATEST", 
    }, 
    {
      code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
      code_size: 5797206, 
      description: "Process image objects from Amazon S3.", 
      durable_config: {
        execution_timeout: 31622400, 
        retention_period_in_days: 30, 
      }, 
      environment: {
        variables: {
          "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
          "PREFIX" => "inbound", 
        }, 
      }, 
      function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
      function_name: "my-function", 
      handler: "index.handler", 
      kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
      last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
      memory_size: 256, 
      revision_id: "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", 
      role: "arn:aws:iam::123456789012:role/lambda-role", 
      runtime: "nodejs12.x", 
      timeout: 5, 
      tracing_config: {
        mode: "Active", 
      }, 
      version: "1", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_versions_by_function({
  function_name: "NamespacedFunctionName", # required
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.versions #=> Array
resp.versions[0].function_name #=> String
resp.versions[0].function_arn #=> String
resp.versions[0].runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.versions[0].role #=> String
resp.versions[0].handler #=> String
resp.versions[0].code_size #=> Integer
resp.versions[0].description #=> String
resp.versions[0].timeout #=> Integer
resp.versions[0].memory_size #=> Integer
resp.versions[0].last_modified #=> Time
resp.versions[0].code_sha_256 #=> String
resp.versions[0].version #=> String
resp.versions[0].vpc_config.subnet_ids #=> Array
resp.versions[0].vpc_config.subnet_ids[0] #=> String
resp.versions[0].vpc_config.security_group_ids #=> Array
resp.versions[0].vpc_config.security_group_ids[0] #=> String
resp.versions[0].vpc_config.vpc_id #=> String
resp.versions[0].vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.versions[0].dead_letter_config.target_arn #=> String
resp.versions[0].environment.variables #=> Hash
resp.versions[0].environment.variables["EnvironmentVariableName"] #=> String
resp.versions[0].environment.error.error_code #=> String
resp.versions[0].environment.error.message #=> String
resp.versions[0].kms_key_arn #=> String
resp.versions[0].tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.versions[0].master_arn #=> String
resp.versions[0].revision_id #=> String
resp.versions[0].layers #=> Array
resp.versions[0].layers[0].arn #=> String
resp.versions[0].layers[0].code_size #=> Integer
resp.versions[0].layers[0].signing_profile_version_arn #=> String
resp.versions[0].layers[0].signing_job_arn #=> String
resp.versions[0].state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.versions[0].state_reason #=> String
resp.versions[0].state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.versions[0].last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.versions[0].last_update_status_reason #=> String
resp.versions[0].last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.versions[0].file_system_configs #=> Array
resp.versions[0].file_system_configs[0].arn #=> String
resp.versions[0].file_system_configs[0].local_mount_path #=> String
resp.versions[0].file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.versions[0].signing_profile_version_arn #=> String
resp.versions[0].signing_job_arn #=> String
resp.versions[0].package_type #=> String, one of "Zip", "Image"
resp.versions[0].image_config_response.image_config.entry_point #=> Array
resp.versions[0].image_config_response.image_config.entry_point[0] #=> String
resp.versions[0].image_config_response.image_config.command #=> Array
resp.versions[0].image_config_response.image_config.command[0] #=> String
resp.versions[0].image_config_response.image_config.working_directory #=> String
resp.versions[0].image_config_response.error.error_code #=> String
resp.versions[0].image_config_response.error.message #=> String
resp.versions[0].architectures #=> Array
resp.versions[0].architectures[0] #=> String, one of "x86_64", "arm64"
resp.versions[0].ephemeral_storage.size #=> Integer
resp.versions[0].snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.versions[0].snap_start.optimization_status #=> String, one of "On", "Off"
resp.versions[0].runtime_version_config.runtime_version_arn #=> String
resp.versions[0].runtime_version_config.error.error_code #=> String
resp.versions[0].runtime_version_config.error.message #=> String
resp.versions[0].logging_config.log_format #=> String, one of "JSON", "Text"
resp.versions[0].logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.versions[0].logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.versions[0].logging_config.log_group #=> String
resp.versions[0].tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.versions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.versions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.versions[0].capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.versions[0].config_sha_256 #=> String
resp.versions[0].durable_config.kms_key_arn #=> String
resp.versions[0].durable_config.retention_period_in_days #=> Integer
resp.versions[0].durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :marker (String) —

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

  • :max_items (Integer) —

    The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response, even if you set the number higher.

Returns:

See Also:



6997
6998
6999
7000
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 6997

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

#publish_layer_version(params = {}) ⇒ Types::PublishLayerVersionResponse

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

Examples:

Example: To create a Lambda layer version


# The following example creates a new Python library layer version. The command retrieves the layer content a file named
# layer.zip in the specified S3 bucket.

resp = client.publish_layer_version({
  compatible_runtimes: [
    "python3.6", 
    "python3.7", 
  ], 
  content: {
    s3_bucket: "lambda-layers-us-west-2-123456789012", 
    s3_key: "layer.zip", 
  }, 
  description: "My Python layer", 
  layer_name: "my-layer", 
  license_info: "MIT", 
})

resp.to_h outputs the following:
{
  compatible_runtimes: [
    "python3.6", 
    "python3.7", 
  ], 
  content: {
    code_sha_256: "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", 
    code_size: 169, 
    location: "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", 
  }, 
  created_date: Time.parse("2018-11-14T23:03:52.894+0000"), 
  description: "My Python layer", 
  layer_arn: "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", 
  layer_version_arn: "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", 
  license_info: "MIT", 
  version: 1, 
}

Request syntax with placeholder values


resp = client.publish_layer_version({
  layer_name: "LayerName", # required
  description: "Description",
  content: { # required
    s3_bucket: "S3Bucket",
    s3_key: "S3Key",
    s3_object_version: "S3ObjectVersion",
    s3_object_storage_mode: "COPY", # accepts COPY, REFERENCE
    zip_file: "data",
  },
  compatible_architectures: ["x86_64"], # accepts x86_64, arm64
  compatible_runtimes: ["nodejs"], # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, nodejs10.x, nodejs12.x, nodejs14.x, nodejs16.x, nodejs18.x, nodejs20.x, nodejs22.x, nodejs24.x, java8, java8.al2, java11, java17, java21, java25, python2.7, python3.6, python3.7, python3.8, python3.9, python3.10, python3.11, python3.12, python3.13, python3.14, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, dotnet6, dotnet8, dotnet10, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, ruby3.2, ruby3.3, ruby3.4, ruby4.0, provided, provided.al2, provided.al2023, nodejs26.x, python3.15, java8.al2023, java11.al2023, java17.al2023
  license_info: "LicenseInfo",
})

Response structure


resp.content.location #=> String
resp.content.code_sha_256 #=> String
resp.content.code_size #=> Integer
resp.content.signing_profile_version_arn #=> String
resp.content.signing_job_arn #=> String
resp.content.resolved_s3_object.s3_bucket #=> String
resp.content.resolved_s3_object.s3_key #=> String
resp.content.resolved_s3_object.s3_object_version #=> String
resp.layer_arn #=> String
resp.layer_version_arn #=> String
resp.description #=> String
resp.created_date #=> Time
resp.version #=> Integer
resp.compatible_architectures #=> Array
resp.compatible_architectures[0] #=> String, one of "x86_64", "arm64"
resp.compatible_runtimes #=> Array
resp.compatible_runtimes[0] #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.license_info #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :description (String) —

    The description of the version.

  • :content (required, Types::LayerVersionContentInput) —

    The function layer archive.

  • :compatible_architectures (Array<String>) —

    A list of compatible instruction set architectures.

  • :compatible_runtimes (Array<String>) —

    A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

    The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

  • :license_info (String) —

    The layer's software license. It can be any of the following:

    • An SPDX license identifier. For example, MIT.

    • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

    • The full text of the license.

Returns:

See Also:



7148
7149
7150
7151
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7148

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

#publish_version(params = {}) ⇒ Types::FunctionConfiguration

Creates a version from the current code and configuration of a Lambda Event Function. Use versions to create a snapshot of your function code and configuration that doesn't change.

Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

Examples:

Example: To publish a version of a Lambda function


# This operation publishes a version of a Lambda function

resp = client.publish_version({
  code_sha_256: "", 
  description: "", 
  function_name: "myFunction", 
})

resp.to_h outputs the following:
{
  code_sha_256: "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=", 
  code_size: 5797206, 
  description: "Process image objects from Amazon S3.", 
  environment: {
    variables: {
      "BUCKET" => "my-bucket-1xpuxmplzrlbh", 
      "PREFIX" => "inbound", 
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  function_name: "my-function", 
  handler: "index.handler", 
  kms_key_arn: "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966", 
  last_modified: Time.parse("2020-04-10T19:06:32.563+0000"), 
  last_update_status: "Successful", 
  memory_size: 256, 
  revision_id: "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727", 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  state: "Active", 
  timeout: 5, 
  tracing_config: {
    mode: "Active", 
  }, 
  version: "1", 
}

Request syntax with placeholder values


resp = client.publish_version({
  function_name: "FunctionName", # required
  code_sha_256: "String",
  description: "Description",
  revision_id: "String",
  publish_to: "LATEST_PUBLISHED", # accepts LATEST_PUBLISHED
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String
resp.layers #=> Array
resp.layers[0].arn #=> String
resp.layers[0].code_size #=> Integer
resp.layers[0].signing_profile_version_arn #=> String
resp.layers[0].signing_job_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.state_reason #=> String
resp.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.last_update_status_reason #=> String
resp.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.file_system_configs #=> Array
resp.file_system_configs[0].arn #=> String
resp.file_system_configs[0].local_mount_path #=> String
resp.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.signing_profile_version_arn #=> String
resp.signing_job_arn #=> String
resp.package_type #=> String, one of "Zip", "Image"
resp.image_config_response.image_config.entry_point #=> Array
resp.image_config_response.image_config.entry_point[0] #=> String
resp.image_config_response.image_config.command #=> Array
resp.image_config_response.image_config.command[0] #=> String
resp.image_config_response.image_config.working_directory #=> String
resp.image_config_response.error.error_code #=> String
resp.image_config_response.error.message #=> String
resp.architectures #=> Array
resp.architectures[0] #=> String, one of "x86_64", "arm64"
resp.ephemeral_storage.size #=> Integer
resp.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.snap_start.optimization_status #=> String, one of "On", "Off"
resp.runtime_version_config.runtime_version_arn #=> String
resp.runtime_version_config.error.error_code #=> String
resp.runtime_version_config.error.message #=> String
resp.logging_config.log_format #=> String, one of "JSON", "Text"
resp.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.logging_config.log_group #=> String
resp.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.config_sha_256 #=> String
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :code_sha_256 (String) —

    Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.

  • :description (String) —

    A description for the version to override the description in the function configuration.

  • :revision_id (String) —

    Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.

  • :publish_to (String) —

    Specifies where to publish the function version or configuration.

Returns:

See Also:



7375
7376
7377
7378
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7375

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

#put_function_code_signing_config(params = {}) ⇒ Types::PutFunctionCodeSigningConfigResponse

Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

Examples:

Request syntax with placeholder values


resp = client.put_function_code_signing_config({
  code_signing_config_arn: "CodeSigningConfigArn", # required
  function_name: "NamespacedFunctionName", # required
})

Response structure


resp.code_signing_config_arn #=> String
resp.function_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :code_signing_config_arn (required, String) —

    The The Amazon Resource Name (ARN) of the code signing configuration.

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

    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:



7423
7424
7425
7426
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7423

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

#put_function_concurrency(params = {}) ⇒ Types::Concurrency

Sets the maximum number of simultaneous executions for a Lambda Event Function, and reserves capacity for that concurrency level.

Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.

Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.

Examples:

Example: To configure a reserved concurrency limit for a function


# The following example configures 100 reserved concurrent executions for the my-function function.

resp = client.put_function_concurrency({
  function_name: "my-function", 
  reserved_concurrent_executions: 100, 
})

resp.to_h outputs the following:
{
  reserved_concurrent_executions: 100, 
}

Request syntax with placeholder values


resp = client.put_function_concurrency({
  function_name: "FunctionName", # required
  reserved_concurrent_executions: 1, # required
})

Response structure


resp.reserved_concurrent_executions #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :reserved_concurrent_executions (required, Integer) —

    The number of simultaneous executions to reserve for the function.

Returns:

See Also:



7499
7500
7501
7502
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7499

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

#put_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig

Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.

By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.

To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.

S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

Examples:

Example: To configure error handling for asynchronous invocation


# The following example sets a maximum event age of one hour and disables retries for the specified function.

resp = client.put_function_event_invoke_config({
  function_name: "my-function", 
  maximum_event_age_in_seconds: 3600, 
  maximum_retry_attempts: 0, 
})

resp.to_h outputs the following:
{
  destination_config: {
    on_failure: {
    }, 
    on_success: {
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", 
  last_modified: Time.parse("2016-11-21T19:49:20.006Z"), 
  maximum_event_age_in_seconds: 3600, 
  maximum_retry_attempts: 0, 
}

Request syntax with placeholder values


resp = client.put_function_event_invoke_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  maximum_retry_attempts: 1,
  maximum_event_age_in_seconds: 1,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
})

Response structure


resp.last_modified #=> Time
resp.function_arn #=> String
resp.maximum_retry_attempts #=> Integer
resp.maximum_event_age_in_seconds #=> Integer
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    A version number or alias name.

  • :maximum_retry_attempts (Integer) —

    The maximum number of times to retry when the function returns an error.

  • :maximum_event_age_in_seconds (Integer) —

    The maximum age of a request that Lambda sends to a function for processing.

  • :destination_config (Types::DestinationConfig) —

    A destination for events after they have been sent to a function for processing.

    Destinations

    • Function - The Amazon Resource Name (ARN) of a Lambda function.

    • Queue - The ARN of a standard SQS queue.

    • Bucket - The ARN of an Amazon S3 bucket.

    • Topic - The ARN of a standard SNS topic.

    • Event Bus - The ARN of an Amazon EventBridge event bus.

    S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

Returns:

See Also:



7646
7647
7648
7649
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7646

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

#put_function_recursion_config(params = {}) ⇒ Types::PutFunctionRecursionConfigResponse

Sets the recursive loop detection configuration for a Lambda Event Function.

When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.

Lambda can detect certain types of recursive loops shortly after they occur. When Lambda detects a recursive loop and your function's recursive loop detection configuration is set to Terminate, it stops your function being invoked and notifies you.

Examples:

Request syntax with placeholder values


resp = client.put_function_recursion_config({
  function_name: "UnqualifiedFunctionName", # required
  recursive_loop: "Allow", # required, accepts Allow, Terminate
})

Response structure


resp.recursive_loop #=> String, one of "Allow", "Terminate"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :recursive_loop (required, String) —

    If you set your function's recursive loop detection configuration to Allow, Lambda doesn't take any action when it detects your function being invoked as part of a recursive loop. We recommend that you only use this setting if your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes it.

    If you set your function's recursive loop detection configuration to Terminate, Lambda stops your function being invoked and notifies you when it detects your function being invoked as part of a recursive loop.

    By default, Lambda sets your function's configuration to Terminate.

    If your design intentionally uses a Lambda function to write data back to the same Amazon Web Services resource that invokes the function, then use caution and implement suitable guard rails to prevent unexpected charges being billed to your Amazon Web Services account. To learn more about best practices for using recursive invocation patterns, see Recursive patterns that cause run-away Lambda functions in Serverless Land.

Returns:

See Also:



7732
7733
7734
7735
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7732

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

#put_function_scaling_config(params = {}) ⇒ Types::PutFunctionScalingConfigResponse

Sets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.

Examples:

Request syntax with placeholder values


resp = client.put_function_scaling_config({
  function_name: "UnqualifiedFunctionName", # required
  qualifier: "PublishedFunctionQualifier", # required
  function_scaling_config: {
    min_execution_environments: 1,
    max_execution_environments: 1,
  },
})

Response structure


resp.function_state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

  • :qualifier (required, String) —

    Specify a version or alias to set the scaling configuration for a published version of the function.

  • :function_scaling_config (Types::FunctionScalingConfig) —

    The scaling configuration to apply to the function, including minimum and maximum execution environment limits.

Returns:

See Also:



7777
7778
7779
7780
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7777

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

#put_provisioned_concurrency_config(params = {}) ⇒ Types::PutProvisionedConcurrencyConfigResponse

Adds a provisioned concurrency configuration to a function's alias or version.

Examples:

Example: To allocate provisioned concurrency


# The following example allocates 100 provisioned concurrency for the BLUE alias of the specified function.

resp = client.put_provisioned_concurrency_config({
  function_name: "my-function", 
  provisioned_concurrent_executions: 100, 
  qualifier: "BLUE", 
})

resp.to_h outputs the following:
{
  allocated_provisioned_concurrent_executions: 0, 
  last_modified: Time.parse("2019-11-21T19:32:12+0000"), 
  requested_provisioned_concurrent_executions: 100, 
  status: "IN_PROGRESS", 
}

Request syntax with placeholder values


resp = client.put_provisioned_concurrency_config({
  function_name: "FunctionName", # required
  qualifier: "Qualifier", # required
  provisioned_concurrent_executions: 1, # required
})

Response structure


resp.requested_provisioned_concurrent_executions #=> Integer
resp.allocated_provisioned_concurrent_executions #=> Integer
resp.available_provisioned_concurrent_executions #=> Integer
resp.status #=> String, one of "IN_PROGRESS", "READY", "FAILED"
resp.status_reason #=> String
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (required, String) —

    The version number or alias name.

  • :provisioned_concurrent_executions (required, Integer) —

    The amount of provisioned concurrency to allocate for the version or alias.

Returns:

See Also:



7856
7857
7858
7859
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7856

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

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

Adds a resource-based policy to a Lambda resource. Resource-based policies grant access to other Amazon Web Services accounts, organizations, or services. Resource-based policies apply to a single Lambda resource (for example, a function, function version, or function alias).

This operation replaces any existing policy on the Lambda resource. If you previously added permissions using the AddPermission operation, the new policy overwrites those permissions.

Examples:

Request syntax with placeholder values


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

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 Lambda resource you want to add the policy to. You can use a qualified or an unqualified ARN. The value must be a complete ARN, and the operation does not accept wildcard characters.

  • :policy (required, String) —

    The policy document you want to add to your Lambda resource. This is formatted as a JSON string.

    For more information, see Working with resource-based policies in Lambda in the Lambda Developer Guide.

  • :revision_id (String) —

    The revision ID that the existing policy must match for the replacement to proceed. If the revision ID doesn't match, the operation fails with a PreconditionFailedException error. To retrieve the current revision ID, use the GetResourcePolicy operation.

Returns:

See Also:



7923
7924
7925
7926
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 7923

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

#put_runtime_management_config(params = {}) ⇒ Types::PutRuntimeManagementConfigResponse

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

Examples:

Request syntax with placeholder values


resp = client.put_runtime_management_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  update_runtime_on: "Auto", # required, accepts Auto, Manual, FunctionUpdate
  runtime_version_arn: "RuntimeVersionArn",
})

Response structure


resp.update_runtime_on #=> String, one of "Auto", "Manual", "FunctionUpdate"
resp.function_arn #=> String
resp.runtime_version_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    Specify a version of the function. This can be $LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.

  • :update_runtime_on (required, String) —

    Specify the runtime update mode.

    • Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.

    • Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.

    • Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.

  • :runtime_version_arn (String) —

    The ARN of the runtime version you want the function to use.

    This is only required if you're using the Manual runtime update mode.

Returns:

See Also:



8016
8017
8018
8019
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8016

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

#remove_layer_version_permission(params = {}) ⇒ Struct

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Examples:

Example: To delete layer-version permissions


# The following example deletes permission for an account to configure a layer version.

resp = client.remove_layer_version_permission({
  layer_name: "my-layer", 
  statement_id: "xaccount", 
  version_number: 1, 
})

Request syntax with placeholder values


resp = client.remove_layer_version_permission({
  layer_name: "LayerName", # required
  version_number: 1, # required
  statement_id: "StatementId", # required
  revision_id: "String",
})

Parameters:

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

    ({})

Options Hash (params):

  • :layer_name (required, String) —

    The name or Amazon Resource Name (ARN) of the layer.

  • :version_number (required, Integer) —

    The version number.

  • :statement_id (required, String) —

    The identifier that was specified when the statement was added.

  • :revision_id (String) —

    Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8069
8070
8071
8072
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8069

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

#remove_permission(params = {}) ⇒ Struct

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.

Examples:

Example: To remove a Lambda function's permissions


# The following example removes a permissions statement named xaccount from the PROD alias of a function named
# my-function.

resp = client.remove_permission({
  function_name: "my-function", 
  qualifier: "PROD", 
  statement_id: "xaccount", 
})

Request syntax with placeholder values


resp = client.remove_permission({
  function_name: "NamespacedFunctionName", # required
  statement_id: "NamespacedStatementId", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  revision_id: "String",
})

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name – my-function (name-only), my-function:v1 (with alias).

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :statement_id (required, String) —

    Statement ID of the permission to remove.

  • :qualifier (String) —

    Specify a version or alias to remove permissions from a published version of the function.

  • :revision_id (String) —

    Update the policy only if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8134
8135
8136
8137
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8134

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

#send_durable_execution_callback_failure(params = {}) ⇒ Struct

Sends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.

Examples:

Request syntax with placeholder values


resp = client.send_durable_execution_callback_failure({
  callback_id: "CallbackId", # required
  error: {
    error_message: "ErrorMessage",
    error_type: "ErrorType",
    error_data: "ErrorData",
    stack_trace: ["StackTraceEntry"],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :callback_id (required, String) —

    The unique identifier for the callback operation.

  • :error (Types::ErrorObject) —

    Error details describing why the callback operation failed. The combined size of all error fields is limited to 1 MB.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8168
8169
8170
8171
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8168

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

#send_durable_execution_callback_heartbeat(params = {}) ⇒ Struct

Sends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.

Examples:

Request syntax with placeholder values


resp = client.send_durable_execution_callback_heartbeat({
  callback_id: "CallbackId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :callback_id (required, String) —

    The unique identifier for the callback operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8192
8193
8194
8195
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8192

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

#send_durable_execution_callback_success(params = {}) ⇒ Struct

Sends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.

Examples:

Request syntax with placeholder values


resp = client.send_durable_execution_callback_success({
  callback_id: "CallbackId", # required
  result: "data",
})

Parameters:

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

    ({})

Options Hash (params):

  • :callback_id (required, String) —

    The unique identifier for the callback operation.

  • :result (String, StringIO, File) —

    The result data from the successful callback operation. Maximum size is 1 MB.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8221
8222
8223
8224
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8221

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

#stop_durable_execution(params = {}) ⇒ Types::StopDurableExecutionResponse

Stops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.

Examples:

Request syntax with placeholder values


resp = client.stop_durable_execution({
  durable_execution_arn: "DurableExecutionArn", # required
  error: {
    error_message: "ErrorMessage",
    error_type: "ErrorType",
    error_data: "ErrorData",
    stack_trace: ["StackTraceEntry"],
  },
})

Response structure


resp.stop_timestamp #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :durable_execution_arn (required, String) —

    The Amazon Resource Name (ARN) of the durable execution.

  • :error (Types::ErrorObject) —

    Optional error details explaining why the execution is being stopped. The combined size of all error fields is limited to 1 MB.

Returns:

See Also:



8265
8266
8267
8268
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8265

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a function, event source mapping, or code signing configuration.

Examples:

Example: To add tags to an existing Lambda function


# The following example adds a tag with the key name DEPARTMENT and a value of 'Department A' to the specified Lambda
# function.

resp = client.tag_resource({
  resource: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  tags: {
    "DEPARTMENT" => "Department A", 
  }, 
})

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The resource's Amazon Resource Name (ARN).

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

    A list of tags to apply to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8311
8312
8313
8314
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8311

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a function, event source mapping, or code signing configuration.

Examples:

Example: To remove tags from an existing Lambda function


# The following example removes the tag with the key name DEPARTMENT tag from the my-function Lambda function.

resp = client.untag_resource({
  resource: "arn:aws:lambda:us-west-2:123456789012:function:my-function", 
  tag_keys: [
    "DEPARTMENT", 
  ], 
})

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource (required, String) —

    The resource's Amazon Resource Name (ARN).

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

    A list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



8354
8355
8356
8357
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8354

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

#update_alias(params = {}) ⇒ Types::AliasConfiguration

Updates the configuration of a Lambda Event Function alias.

Examples:

Example: To update a function alias


# The following example updates the alias named BLUE to send 30% of traffic to version 2 and 70% to version 1.

resp = client.update_alias({
  function_name: "my-function", 
  function_version: "2", 
  name: "BLUE", 
  routing_config: {
    additional_version_weights: {
      "1" => 0.7, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  alias_arn: "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE", 
  description: "Production environment BLUE.", 
  function_version: "2", 
  name: "BLUE", 
  revision_id: "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93", 
  routing_config: {
    additional_version_weights: {
      "1" => 0.7, 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.update_alias({
  function_name: "FunctionName", # required
  name: "Alias", # required
  function_version: "VersionWithLatestPublished",
  description: "Description",
  routing_config: {
    additional_version_weights: {
      "AdditionalVersion" => 1.0,
    },
  },
  revision_id: "String",
})

Response structure


resp.alias_arn #=> String
resp.name #=> String
resp.function_version #=> String
resp.description #=> String
resp.routing_config.additional_version_weights #=> Hash
resp.routing_config.additional_version_weights["AdditionalVersion"] #=> Float
resp.revision_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Partial ARN - 123456789012:function:MyFunction.

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

  • :name (required, String) —

    The name of the alias.

  • :function_version (String) —

    The function version that the alias invokes.

  • :description (String) —

    A description of the alias.

  • :routing_config (Types::AliasRoutingConfiguration) —

    The routing configuration of the alias.

  • :revision_id (String) —

    Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

Returns:

See Also:



8469
8470
8471
8472
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8469

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

#update_capacity_provider(params = {}) ⇒ Types::UpdateCapacityProviderResponse

Updates the configuration of an existing capacity provider.

Examples:

Request syntax with placeholder values


resp = client.update_capacity_provider({
  capacity_provider_name: "CapacityProviderName", # required
  capacity_provider_scaling_config: {
    max_v_cpu_count: 1,
    scaling_mode: "Auto", # accepts Auto, Manual
    scaling_policies: [
      {
        predefined_metric_type: "LambdaCapacityProviderAverageCPUUtilization", # required, accepts LambdaCapacityProviderAverageCPUUtilization
        target_value: 1.0, # required
      },
    ],
  },
  propagate_tags: {
    mode: "None", # accepts None, Explicit
    explicit_tags: {
      "TagKey" => "TagValue",
    },
  },
  telemetry_config: {
    logging_config: {
      system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
      log_group: "LogGroup",
    },
  },
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.state #=> String, one of "Pending", "Active", "Failed", "Deleting"
resp.capacity_provider.vpc_config.subnet_ids #=> Array
resp.capacity_provider.vpc_config.subnet_ids[0] #=> String
resp.capacity_provider.vpc_config.security_group_ids #=> Array
resp.capacity_provider.vpc_config.security_group_ids[0] #=> String
resp.capacity_provider.permissions_config.capacity_provider_operator_role_arn #=> String
resp.capacity_provider.instance_requirements.architectures #=> Array
resp.capacity_provider.instance_requirements.architectures[0] #=> String, one of "x86_64", "arm64"
resp.capacity_provider.instance_requirements.allowed_instance_types #=> Array
resp.capacity_provider.instance_requirements.allowed_instance_types[0] #=> String
resp.capacity_provider.instance_requirements.excluded_instance_types #=> Array
resp.capacity_provider.instance_requirements.excluded_instance_types[0] #=> String
resp.capacity_provider.capacity_provider_scaling_config.max_v_cpu_count #=> Integer
resp.capacity_provider.capacity_provider_scaling_config.scaling_mode #=> String, one of "Auto", "Manual"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies #=> Array
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].predefined_metric_type #=> String, one of "LambdaCapacityProviderAverageCPUUtilization"
resp.capacity_provider.capacity_provider_scaling_config.scaling_policies[0].target_value #=> Float
resp.capacity_provider.kms_key_arn #=> String
resp.capacity_provider.last_modified #=> Time
resp.capacity_provider.propagate_tags.mode #=> String, one of "None", "Explicit"
resp.capacity_provider.propagate_tags.explicit_tags #=> Hash
resp.capacity_provider.propagate_tags.explicit_tags["TagKey"] #=> String
resp.capacity_provider.telemetry_config.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.capacity_provider.telemetry_config.logging_config.log_group #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :capacity_provider_name (required, String) —

    The name of the capacity provider to update.

  • :capacity_provider_scaling_config (Types::CapacityProviderScalingConfig) —

    The updated scaling configuration for the capacity provider.

  • :propagate_tags (Types::PropagateTags) —

    Configuration for tag propagation to managed resources launched by the capacity provider.

  • :telemetry_config (Types::CapacityProviderTelemetryConfig) —

    The updated telemetry configuration for the capacity provider.

Returns:

See Also:



8553
8554
8555
8556
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8553

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

#update_code_signing_config(params = {}) ⇒ Types::UpdateCodeSigningConfigResponse

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

Examples:

Request syntax with placeholder values


resp = client.update_code_signing_config({
  code_signing_config_arn: "CodeSigningConfigArn", # required
  description: "Description",
  allowed_publishers: {
    signing_profile_version_arns: ["Arn"], # required
  },
  code_signing_policies: {
    untrusted_artifact_on_deployment: "Warn", # accepts Warn, Enforce
  },
})

Response structure


resp.code_signing_config.code_signing_config_id #=> String
resp.code_signing_config.code_signing_config_arn #=> String
resp.code_signing_config.description #=> String
resp.code_signing_config.allowed_publishers.signing_profile_version_arns #=> Array
resp.code_signing_config.allowed_publishers.signing_profile_version_arns[0] #=> String
resp.code_signing_config.code_signing_policies.untrusted_artifact_on_deployment #=> String, one of "Warn", "Enforce"
resp.code_signing_config.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :code_signing_config_arn (required, String) —

    The The Amazon Resource Name (ARN) of the code signing configuration.

  • :description (String) —

    Descriptive name for this code signing configuration.

  • :allowed_publishers (Types::AllowedPublishers) —

    Signing profiles for this code signing configuration.

  • :code_signing_policies (Types::CodeSigningPolicies) —

    The code signing policy.

Returns:

See Also:



8605
8606
8607
8608
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 8605

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

#update_event_source_mapping(params = {}) ⇒ Types::EventSourceMappingConfiguration

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

For details about how to configure different event sources, see the following topics.

The following error handling options are available for stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka):

  • BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

  • MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

  • MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

  • OnFailure – Send discarded records to an Amazon SQS queue, Amazon SNS topic, Kafka topic, or Amazon S3 bucket. For more information, see Adding a destination.

The following option is available only for DynamoDB and Kinesis event sources:

  • ParallelizationFactor – Process multiple batches from each shard concurrently.

^

For information about which configuration parameters apply to each event source, see the following topics.

Examples:

Example: To update a Lambda function event source mapping


# This operation updates a Lambda function event source mapping

resp = client.update_event_source_mapping({
  batch_size: 123, 
  enabled: true, 
  function_name: "myFunction", 
  uuid: "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", 
})

resp.to_h outputs the following:
{
  batch_size: 123, 
  event_source_arn: "arn:aws:s3:::examplebucket/*", 
  function_arn: "arn:aws:lambda:us-west-2:123456789012:function:myFunction", 
  last_modified: Time.parse("2016-11-21T19:49:20.006Z"), 
  last_processing_result: "", 
  state: "", 
  state_transition_reason: "", 
  uuid: "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", 
}

Request syntax with placeholder values


resp = client.update_event_source_mapping({
  uuid: "UUIDString", # required
  function_name: "NamespacedFunctionName",
  enabled: false,
  batch_size: 1,
  filter_criteria: {
    filters: [
      {
        pattern: "Pattern",
      },
    ],
  },
  kms_key_arn: "KMSKeyArn",
  metrics_config: {
    metrics: ["EventCount"], # accepts EventCount, ErrorCount, KafkaMetrics
  },
  logging_config: {
    system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
  },
  scaling_config: {
    maximum_concurrency: 1,
  },
  maximum_batching_window_in_seconds: 1,
  parallelization_factor: 1,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
  maximum_record_age_in_seconds: 1,
  bisect_batch_on_function_error: false,
  maximum_retry_attempts: 1,
  tumbling_window_in_seconds: 1,
  source_access_configurations: [
    {
      type: "BASIC_AUTH", # accepts BASIC_AUTH, VPC_SUBNET, VPC_SECURITY_GROUP, SASL_SCRAM_512_AUTH, SASL_SCRAM_256_AUTH, VIRTUAL_HOST, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH, OAUTHBEARER_SCOPE, OAUTHBEARER_AUDIENCE, OAUTHBEARER_LOGICAL_CLUSTER, OAUTHBEARER_IDENTITY_POOL, IAM_AUTH, IAM_OAUTHBEARER_AUTH
      uri: "URI",
    },
  ],
  function_response_types: ["ReportBatchItemFailures"], # accepts ReportBatchItemFailures
  amazon_managed_kafka_event_source_config: {
    consumer_group_id: "URI",
    schema_registry_config: {
      schema_registry_uri: "SchemaRegistryUri",
      event_record_format: "JSON", # accepts JSON, SOURCE
      access_configs: [
        {
          type: "BASIC_AUTH", # accepts BASIC_AUTH, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH
          uri: "Arn",
        },
      ],
      schema_validation_configs: [
        {
          attribute: "KEY", # accepts KEY, VALUE
        },
      ],
    },
  },
  self_managed_kafka_event_source_config: {
    consumer_group_id: "URI",
    schema_registry_config: {
      schema_registry_uri: "SchemaRegistryUri",
      event_record_format: "JSON", # accepts JSON, SOURCE
      access_configs: [
        {
          type: "BASIC_AUTH", # accepts BASIC_AUTH, CLIENT_CERTIFICATE_TLS_AUTH, SERVER_ROOT_CA_CERTIFICATE, OAUTHBEARER_AUTH
          uri: "Arn",
        },
      ],
      schema_validation_configs: [
        {
          attribute: "KEY", # accepts KEY, VALUE
        },
      ],
    },
    consumption_mode: "Stream", # accepts Stream, Queue
  },
  document_db_event_source_config: {
    database_name: "DatabaseName",
    collection_name: "CollectionName",
    full_document: "UpdateLookup", # accepts UpdateLookup, Default
  },
  provisioned_poller_config: {
    minimum_pollers: 1,
    maximum_pollers: 1,
    poller_group_name: "ProvisionedPollerGroupName",
  },
})

Response structure


resp.uuid #=> String
resp.starting_position #=> String, one of "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"
resp.starting_position_timestamp #=> Time
resp.batch_size #=> Integer
resp.maximum_batching_window_in_seconds #=> Integer
resp.parallelization_factor #=> Integer
resp.event_source_arn #=> String
resp.filter_criteria.filters #=> Array
resp.filter_criteria.filters[0].pattern #=> String
resp.filter_criteria_error.error_code #=> String
resp.filter_criteria_error.message #=> String
resp.kms_key_arn #=> String
resp.metrics_config.metrics #=> Array
resp.metrics_config.metrics[0] #=> String, one of "EventCount", "ErrorCount", "KafkaMetrics"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.scaling_config.maximum_concurrency #=> Integer
resp.function_arn #=> String
resp.last_modified #=> Time
resp.last_processing_result #=> String
resp.state #=> String
resp.state_transition_reason #=> String
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String
resp.topics #=> Array
resp.topics[0] #=> String
resp.queues #=> Array
resp.queues[0] #=> String
resp.source_access_configurations #=> Array
resp.source_access_configurations[0].type #=> String, one of "BASIC_AUTH", "VPC_SUBNET", "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", "VIRTUAL_HOST", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH", "OAUTHBEARER_SCOPE", "OAUTHBEARER_AUDIENCE", "OAUTHBEARER_LOGICAL_CLUSTER", "OAUTHBEARER_IDENTITY_POOL", "IAM_AUTH", "IAM_OAUTHBEARER_AUTH"
resp.source_access_configurations[0].uri #=> String
resp.self_managed_event_source.endpoints #=> Hash
resp.self_managed_event_source.endpoints["EndPointType"] #=> Array
resp.self_managed_event_source.endpoints["EndPointType"][0] #=> String
resp.maximum_record_age_in_seconds #=> Integer
resp.bisect_batch_on_function_error #=> Boolean
resp.maximum_retry_attempts #=> Integer
resp.tumbling_window_in_seconds #=> Integer
resp.function_response_types #=> Array
resp.function_response_types[0] #=> String, one of "ReportBatchItemFailures"
resp.amazon_managed_kafka_event_source_config.consumer_group_id #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.amazon_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.amazon_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumer_group_id #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_registry_uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.event_record_format #=> String, one of "JSON", "SOURCE"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].type #=> String, one of "BASIC_AUTH", "CLIENT_CERTIFICATE_TLS_AUTH", "SERVER_ROOT_CA_CERTIFICATE", "OAUTHBEARER_AUTH"
resp.self_managed_kafka_event_source_config.schema_registry_config.access_configs[0].uri #=> String
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs #=> Array
resp.self_managed_kafka_event_source_config.schema_registry_config.schema_validation_configs[0].attribute #=> String, one of "KEY", "VALUE"
resp.self_managed_kafka_event_source_config.consumption_mode #=> String, one of "Stream", "Queue"
resp.document_db_event_source_config.database_name #=> String
resp.document_db_event_source_config.collection_name #=> String
resp.document_db_event_source_config.full_document #=> String, one of "UpdateLookup", "Default"
resp.event_source_mapping_arn #=> String
resp.provisioned_poller_config.minimum_pollers #=> Integer
resp.provisioned_poller_config.maximum_pollers #=> Integer
resp.provisioned_poller_config.poller_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The identifier of the event source mapping.

  • :function_name (String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – MyFunction.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

    • Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

    • Partial ARN – 123456789012:function:MyFunction.

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

  • :enabled (Boolean) —

    When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

    Default: True

  • :batch_size (Integer) —

    The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

    • Amazon Kinesis – Default 100. Max 10,000.

    • Amazon DynamoDB Streams – Default 100. Max 10,000.

    • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

    • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

    • Self-managed Apache Kafka – Default 100. Max 10,000.

    • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

    • DocumentDB – Default 100. Max 10,000.

  • :filter_criteria (Types::FilterCriteria) —

    An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

  • :kms_key_arn (String) —

    The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

  • :metrics_config (Types::EventSourceMappingMetricsConfig) —

    The metrics configuration for your event source. For more information, see Event source mapping metrics.

  • :logging_config (Types::EventSourceMappingLoggingConfig) — default: Amazon MSK, and self-managed Apache Kafka only —

    The logging configuration for your event source. Use this configuration object to define the level of logs for your event source mapping.

  • :scaling_config (Types::ScalingConfig) — default: Amazon SQS only —

    The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

  • :maximum_batching_window_in_seconds (Integer) —

    The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

    For Kinesis, DynamoDB, and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

    Related setting: For Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    Not supported for Kafka event source mappings when ConsumptionMode is Queue.

  • :parallelization_factor (Integer) — default: Kinesis and DynamoDB Streams only —

    The number of batches to process from each shard concurrently.

  • :destination_config (Types::DestinationConfig) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    A configuration object that specifies the destination of an event after Lambda processes it.

  • :maximum_record_age_in_seconds (Integer) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    Discard records older than the specified age. The default value is infinite (-1).

  • :bisect_batch_on_function_error (Boolean) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    If the function returns an error, split the batch in two and retry.

  • :maximum_retry_attempts (Integer) — default: Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka —

    Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

    For Kafka Stream consumption mode, the default is -1 (infinite retries; capped at 10 when an on-failure destination is configured). For Kafka Queue consumption mode, the default is 0, and if no on-failure destination is configured the Kafka broker performs retries.

  • :tumbling_window_in_seconds (Integer) — default: Kinesis and DynamoDB Streams only —

    The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

  • :source_access_configurations (Array<Types::SourceAccessConfiguration>) —

    An array of authentication protocols or VPC components required to secure your event source.

  • :function_response_types (Array<String>) — default: Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS —

    A list of current response type enums applied to the event source mapping.

  • :amazon_managed_kafka_event_source_config (Types::AmazonManagedKafkaEventSourceConfig) —

    Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

  • :self_managed_kafka_event_source_config (Types::SelfManagedKafkaEventSourceConfig) —

    Specific configuration settings for a self-managed Apache Kafka event source.

  • :document_db_event_source_config (Types::DocumentDBEventSourceConfig) —

    Specific configuration settings for a DocumentDB event source.

  • :provisioned_poller_config (Types::ProvisionedPollerConfig) — default: Amazon SQS, Amazon MSK, and self-managed Apache Kafka only —

    The provisioned mode configuration for the event source. For more information, see provisioned mode.

Returns:

See Also:



9092
9093
9094
9095
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 9092

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

#update_function_code(params = {}) ⇒ Types::FunctionConfiguration

Updates a Lambda Event Function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda.

If the function's package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.

Examples:

Example: To update a Lambda function's code


# The following example replaces the code of the unpublished ($LATEST) version of a function named my-function with the
# contents of the specified zip file in Amazon S3.

resp = client.update_function_code({
  function_name: "my-function", 
  s3_bucket: "my-bucket-1xpuxmplzrlbh", 
  s3_key: "function.zip", 
})

resp.to_h outputs the following:
{
  code_sha_256: "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", 
  code_size: 308, 
  description: "", 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function", 
  function_name: "my-function", 
  handler: "index.handler", 
  last_modified: Time.parse("2019-08-14T22:26:11.234+0000"), 
  memory_size: 128, 
  revision_id: "873282ed-xmpl-4dc8-a069-d0c647e470c6", 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  timeout: 3, 
  tracing_config: {
    mode: "PassThrough", 
  }, 
  version: "$LATEST", 
}

Request syntax with placeholder values


resp = client.update_function_code({
  function_name: "FunctionName", # required
  zip_file: "data",
  s3_bucket: "S3Bucket",
  s3_key: "S3Key",
  s3_object_version: "S3ObjectVersion",
  s3_object_storage_mode: "COPY", # accepts COPY, REFERENCE
  image_uri: "String",
  architectures: ["x86_64"], # accepts x86_64, arm64
  publish: false,
  publish_to: "LATEST_PUBLISHED", # accepts LATEST_PUBLISHED
  dry_run: false,
  revision_id: "String",
  source_kms_key_arn: "KMSKeyArn",
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String
resp.layers #=> Array
resp.layers[0].arn #=> String
resp.layers[0].code_size #=> Integer
resp.layers[0].signing_profile_version_arn #=> String
resp.layers[0].signing_job_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.state_reason #=> String
resp.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.last_update_status_reason #=> String
resp.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.file_system_configs #=> Array
resp.file_system_configs[0].arn #=> String
resp.file_system_configs[0].local_mount_path #=> String
resp.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.signing_profile_version_arn #=> String
resp.signing_job_arn #=> String
resp.package_type #=> String, one of "Zip", "Image"
resp.image_config_response.image_config.entry_point #=> Array
resp.image_config_response.image_config.entry_point[0] #=> String
resp.image_config_response.image_config.command #=> Array
resp.image_config_response.image_config.command[0] #=> String
resp.image_config_response.image_config.working_directory #=> String
resp.image_config_response.error.error_code #=> String
resp.image_config_response.error.message #=> String
resp.architectures #=> Array
resp.architectures[0] #=> String, one of "x86_64", "arm64"
resp.ephemeral_storage.size #=> Integer
resp.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.snap_start.optimization_status #=> String, one of "On", "Off"
resp.runtime_version_config.runtime_version_arn #=> String
resp.runtime_version_config.error.error_code #=> String
resp.runtime_version_config.error.message #=> String
resp.logging_config.log_format #=> String, one of "JSON", "Text"
resp.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.logging_config.log_group #=> String
resp.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.config_sha_256 #=> String
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :zip_file (String, StringIO, File) —

    The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. Use only with a function defined with a .zip file archive deployment package.

  • :s3_bucket (String) —

    An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account. Use only with a function defined with a .zip file archive deployment package.

  • :s3_key (String) —

    The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.

  • :s3_object_version (String) —

    For versioned objects, the version of the deployment package object to use.

  • :s3_object_storage_mode (String) —

    Specifies how the deployment package is stored. Valid values:

    • COPY (default) – Uploads a copy of your deployment package to Lambda.

    • REFERENCE – Lambda references the deployment package from the specified Amazon S3 bucket.

  • :image_uri (String) —

    URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip file archive.

  • :architectures (Array<String>) —

    The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

  • :publish (Boolean) —

    Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.

  • :publish_to (String) —

    Specifies where to publish the function version or configuration.

  • :dry_run (Boolean) —

    Set to true to validate the request parameters and access permissions without modifying the function code.

  • :revision_id (String) —

    Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

  • :source_kms_key_arn (String) —

    The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an Amazon Web Services managed key.

Returns:

See Also:



9376
9377
9378
9379
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 9376

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

#update_function_configuration(params = {}) ⇒ Types::FunctionConfiguration

Modifies the version-specific settings of a Lambda Event Function.

When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Lambda function states.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

Examples:

Example: To update a Lambda function's configuration


# The following example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of a function named
# my-function.

resp = client.update_function_configuration({
  durable_config: {
    execution_timeout: 3600, 
    retention_period_in_days: 45, 
  }, 
  function_name: "my-function", 
  memory_size: 256, 
})

resp.to_h outputs the following:
{
  code_sha_256: "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", 
  code_size: 308, 
  description: "", 
  durable_config: {
    execution_timeout: 3600, 
    retention_period_in_days: 45, 
  }, 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function", 
  function_name: "my-function", 
  handler: "index.handler", 
  last_modified: Time.parse("2019-08-14T22:26:11.234+0000"), 
  memory_size: 256, 
  revision_id: "873282ed-xmpl-4dc8-a069-d0c647e470c6", 
  role: "arn:aws:iam::123456789012:role/lambda-role", 
  runtime: "nodejs12.x", 
  timeout: 3, 
  tracing_config: {
    mode: "PassThrough", 
  }, 
  version: "$LATEST", 
}

Request syntax with placeholder values


resp = client.update_function_configuration({
  function_name: "FunctionName", # required
  role: "RoleArn",
  handler: "Handler",
  description: "Description",
  timeout: 1,
  memory_size: 1,
  vpc_config: {
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
    ipv_6_allowed_for_dual_stack: false,
  },
  environment: {
    variables: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
  },
  runtime: "nodejs", # accepts nodejs, nodejs4.3, nodejs6.10, nodejs8.10, nodejs10.x, nodejs12.x, nodejs14.x, nodejs16.x, nodejs18.x, nodejs20.x, nodejs22.x, nodejs24.x, java8, java8.al2, java11, java17, java21, java25, python2.7, python3.6, python3.7, python3.8, python3.9, python3.10, python3.11, python3.12, python3.13, python3.14, dotnetcore1.0, dotnetcore2.0, dotnetcore2.1, dotnetcore3.1, dotnet6, dotnet8, dotnet10, nodejs4.3-edge, go1.x, ruby2.5, ruby2.7, ruby3.2, ruby3.3, ruby3.4, ruby4.0, provided, provided.al2, provided.al2023, nodejs26.x, python3.15, java8.al2023, java11.al2023, java17.al2023
  dead_letter_config: {
    target_arn: "ResourceArn",
  },
  kms_key_arn: "KMSKeyArn",
  tracing_config: {
    mode: "Active", # accepts Active, PassThrough
  },
  revision_id: "String",
  layers: ["LayerVersionArn"],
  file_system_configs: [
    {
      arn: "FileSystemArn", # required
      local_mount_path: "LocalMountPath", # required
      s3_files_config: {
        direct_s3_read: "ENABLED", # accepts ENABLED, DISABLED, AUTO
      },
    },
  ],
  image_config: {
    entry_point: ["String"],
    command: ["String"],
    working_directory: "WorkingDirectory",
  },
  ephemeral_storage: {
    size: 1, # required
  },
  snap_start: {
    apply_on: "PublishedVersions", # accepts PublishedVersions, None
  },
  logging_config: {
    log_format: "JSON", # accepts JSON, Text
    application_log_level: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
    system_log_level: "DEBUG", # accepts DEBUG, INFO, WARN
    log_group: "LogGroup",
  },
  capacity_provider_config: {
    lambda_managed_instances_capacity_provider_config: { # required
      capacity_provider_arn: "CapacityProviderArn", # required
      per_execution_environment_max_concurrency: 1,
      execution_environment_memory_gi_b_per_v_cpu: 1.0,
    },
  },
  durable_config: {
    kms_key_arn: "KMSKeyArn",
    retention_period_in_days: 1,
    execution_timeout: 1,
  },
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.runtime #=> String, one of "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "nodejs10.x", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "nodejs20.x", "nodejs22.x", "nodejs24.x", "java8", "java8.al2", "java11", "java17", "java21", "java25", "python2.7", "python3.6", "python3.7", "python3.8", "python3.9", "python3.10", "python3.11", "python3.12", "python3.13", "python3.14", "dotnetcore1.0", "dotnetcore2.0", "dotnetcore2.1", "dotnetcore3.1", "dotnet6", "dotnet8", "dotnet10", "nodejs4.3-edge", "go1.x", "ruby2.5", "ruby2.7", "ruby3.2", "ruby3.3", "ruby3.4", "ruby4.0", "provided", "provided.al2", "provided.al2023", "nodejs26.x", "python3.15", "java8.al2023", "java11.al2023", "java17.al2023"
resp.role #=> String
resp.handler #=> String
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time
resp.code_sha_256 #=> String
resp.version #=> String
resp.vpc_config.subnet_ids #=> Array
resp.vpc_config.subnet_ids[0] #=> String
resp.vpc_config.security_group_ids #=> Array
resp.vpc_config.security_group_ids[0] #=> String
resp.vpc_config.vpc_id #=> String
resp.vpc_config.ipv_6_allowed_for_dual_stack #=> Boolean
resp.dead_letter_config.target_arn #=> String
resp.environment.variables #=> Hash
resp.environment.variables["EnvironmentVariableName"] #=> String
resp.environment.error.error_code #=> String
resp.environment.error.message #=> String
resp.kms_key_arn #=> String
resp.tracing_config.mode #=> String, one of "Active", "PassThrough"
resp.master_arn #=> String
resp.revision_id #=> String
resp.layers #=> Array
resp.layers[0].arn #=> String
resp.layers[0].code_size #=> Integer
resp.layers[0].signing_profile_version_arn #=> String
resp.layers[0].signing_job_arn #=> String
resp.state #=> String, one of "Pending", "Active", "Inactive", "Failed", "Deactivating", "Deactivated", "ActiveNonInvocable", "Deleting"
resp.state_reason #=> String
resp.state_reason_code #=> String, one of "Idle", "Creating", "Restoring", "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DrainingDurableExecutions", "DependencyError"
resp.last_update_status #=> String, one of "Successful", "Failed", "InProgress"
resp.last_update_status_reason #=> String
resp.last_update_status_reason_code #=> String, one of "EniLimitExceeded", "InsufficientRolePermissions", "InvalidConfiguration", "InternalError", "SubnetOutOfIPAddresses", "InvalidSubnet", "InvalidSecurityGroup", "ImageDeleted", "ImageAccessDenied", "InvalidImage", "KMSKeyAccessDenied", "KMSKeyNotFound", "InvalidStateKMSKey", "DisabledKMSKey", "EFSIOError", "EFSMountConnectivityError", "EFSMountFailure", "EFSMountTimeout", "InvalidRuntime", "InvalidZipFileException", "FunctionError", "ServiceQuotaExceededException", "VcpuLimitExceeded", "CapacityProviderScalingLimitExceeded", "InsufficientCapacity", "EC2RequestLimitExceeded", "FunctionError.InitTimeout", "FunctionError.RuntimeInitError", "FunctionError.ExtensionInitError", "FunctionError.InvalidEntryPoint", "FunctionError.InvalidWorkingDirectory", "FunctionError.PermissionDenied", "FunctionError.TooManyExtensions", "FunctionError.InitResourceExhausted", "DisallowedByVpcEncryptionControl", "DependencyError"
resp.file_system_configs #=> Array
resp.file_system_configs[0].arn #=> String
resp.file_system_configs[0].local_mount_path #=> String
resp.file_system_configs[0].s3_files_config.direct_s3_read #=> String, one of "ENABLED", "DISABLED", "AUTO"
resp.signing_profile_version_arn #=> String
resp.signing_job_arn #=> String
resp.package_type #=> String, one of "Zip", "Image"
resp.image_config_response.image_config.entry_point #=> Array
resp.image_config_response.image_config.entry_point[0] #=> String
resp.image_config_response.image_config.command #=> Array
resp.image_config_response.image_config.command[0] #=> String
resp.image_config_response.image_config.working_directory #=> String
resp.image_config_response.error.error_code #=> String
resp.image_config_response.error.message #=> String
resp.architectures #=> Array
resp.architectures[0] #=> String, one of "x86_64", "arm64"
resp.ephemeral_storage.size #=> Integer
resp.snap_start.apply_on #=> String, one of "PublishedVersions", "None"
resp.snap_start.optimization_status #=> String, one of "On", "Off"
resp.runtime_version_config.runtime_version_arn #=> String
resp.runtime_version_config.error.error_code #=> String
resp.runtime_version_config.error.message #=> String
resp.logging_config.log_format #=> String, one of "JSON", "Text"
resp.logging_config.application_log_level #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
resp.logging_config.system_log_level #=> String, one of "DEBUG", "INFO", "WARN"
resp.logging_config.log_group #=> String
resp.tenancy_config.tenant_isolation_mode #=> String, one of "PER_TENANT"
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.capacity_provider_arn #=> String
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.per_execution_environment_max_concurrency #=> Integer
resp.capacity_provider_config.lambda_managed_instances_capacity_provider_config.execution_environment_memory_gi_b_per_v_cpu #=> Float
resp.config_sha_256 #=> String
resp.durable_config.kms_key_arn #=> String
resp.durable_config.retention_period_in_days #=> Integer
resp.durable_config.execution_timeout #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :role (String) —

    The Amazon Resource Name (ARN) of the function's execution role.

  • :handler (String) —

    The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Lambda programming model.

  • :description (String) —

    A description of the function.

  • :timeout (Integer) —

    The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds, and the maximum allowed value is 900 seconds. For functions using Lambda Managed Instances, asynchronous invocations and event source mapping invocations (except Amazon MQ and Amazon DocumentDB) support a maximum allowed value of 5,400 seconds (90 minutes). For more information, see Lambda execution environment.

  • :memory_size (Integer) —

    The amount of memory available to the function at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

  • :vpc_config (Types::VpcConfig) —

    For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.

  • :environment (Types::Environment) —

    Environment variables that are accessible from function code during execution.

  • :runtime (String) —

    The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive. Specifying a runtime results in an error if you're deploying a function using a container image.

    The following list includes deprecated runtimes. Lambda blocks creating new functions and updating existing functions shortly after each runtime is deprecated. For more information, see Runtime use after deprecation.

    For a list of all currently supported runtimes, see Supported runtimes.

  • :dead_letter_config (Types::DeadLetterConfig) —

    A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.

  • :kms_key_arn (String) —

    The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt the following resources:

    • The function's environment variables.

    • The function's Lambda SnapStart snapshots.

    • When used with SourceKMSKeyArn, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see Specifying a customer managed key for Lambda.

    • The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see Function lifecycle.

    If you don't provide a customer managed key, Lambda uses an Amazon Web Services owned key or an Amazon Web Services managed key.

  • :tracing_config (Types::TracingConfig) —

    Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.

  • :revision_id (String) —

    Update the function only if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

  • :layers (Array<String>) —

    A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

  • :file_system_configs (Array<Types::FileSystemConfig>) —

    Connection settings for an Amazon EFS file system or an Amazon S3 Files file system.

  • :image_config (Types::ImageConfig) —

    Container image configuration values that override the values in the container image Docker file.

  • :ephemeral_storage (Types::EphemeralStorage) —

    The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB. For more information, see Configuring ephemeral storage (console).

  • :snap_start (Types::SnapStart) —

    The function's SnapStart setting.

  • :logging_config (Types::LoggingConfig) —

    The function's Amazon CloudWatch Logs configuration settings.

  • :capacity_provider_config (Types::CapacityProviderConfig) —

    Configuration for the capacity provider that manages compute resources for Lambda functions.

  • :durable_config (Types::DurableConfig) —

    Configuration settings for durable functions, including execution timeout, retention period for execution history, and an optional ARN of the Key Management Service (KMS) customer managed key that is used to encrypt your durable execution's payload data, including input, output, and error payloads.

Returns:

See Also:



9830
9831
9832
9833
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 9830

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

#update_function_event_invoke_config(params = {}) ⇒ Types::FunctionEventInvokeConfig

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Examples:

Example: To update an asynchronous invocation configuration


# The following example adds an on-failure destination to the existing asynchronous invocation configuration for a
# function named my-function.

resp = client.update_function_event_invoke_config({
  destination_config: {
    on_failure: {
      destination: "arn:aws:sqs:us-east-2:123456789012:destination", 
    }, 
  }, 
  function_name: "my-function", 
})

resp.to_h outputs the following:
{
  destination_config: {
    on_failure: {
      destination: "arn:aws:sqs:us-east-2:123456789012:destination", 
    }, 
    on_success: {
    }, 
  }, 
  function_arn: "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", 
  last_modified: Time.parse(1573687896.493), 
  maximum_event_age_in_seconds: 3600, 
  maximum_retry_attempts: 0, 
}

Request syntax with placeholder values


resp = client.update_function_event_invoke_config({
  function_name: "NamespacedFunctionName", # required
  qualifier: "NumericLatestPublishedOrAliasQualifier",
  maximum_retry_attempts: 1,
  maximum_event_age_in_seconds: 1,
  destination_config: {
    on_success: {
      destination: "DestinationArn",
    },
    on_failure: {
      destination: "DestinationArn",
    },
  },
})

Response structure


resp.last_modified #=> Time
resp.function_arn #=> String
resp.maximum_retry_attempts #=> Integer
resp.maximum_event_age_in_seconds #=> Integer
resp.destination_config.on_success.destination #=> String
resp.destination_config.on_failure.destination #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    A version number or alias name.

  • :maximum_retry_attempts (Integer) —

    The maximum number of times to retry when the function returns an error.

  • :maximum_event_age_in_seconds (Integer) —

    The maximum age of a request that Lambda sends to a function for processing.

  • :destination_config (Types::DestinationConfig) —

    A destination for events after they have been sent to a function for processing.

    Destinations

    • Function - The Amazon Resource Name (ARN) of a Lambda function.

    • Queue - The ARN of a standard SQS queue.

    • Bucket - The ARN of an Amazon S3 bucket.

    • Topic - The ARN of a standard SNS topic.

    • Event Bus - The ARN of an Amazon EventBridge event bus.

    S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type.

Returns:

See Also:



9958
9959
9960
9961
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 9958

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

#update_function_url_config(params = {}) ⇒ Types::UpdateFunctionUrlConfigResponse

Updates the configuration for a function URL of a Lambda Event Function.

Examples:

Request syntax with placeholder values


resp = client.update_function_url_config({
  function_name: "FunctionUrlFunctionName", # required
  qualifier: "FunctionUrlQualifier",
  auth_type: "NONE", # accepts NONE, AWS_IAM
  cors: {
    allow_credentials: false,
    allow_headers: ["Header"],
    allow_methods: ["Method"],
    allow_origins: ["Origin"],
    expose_headers: ["Header"],
    max_age: 1,
  },
  invoke_mode: "BUFFERED", # accepts BUFFERED, RESPONSE_STREAM
})

Response structure


resp.function_url #=> String
resp.function_arn #=> String
resp.auth_type #=> String, one of "NONE", "AWS_IAM"
resp.cors.allow_credentials #=> Boolean
resp.cors.allow_headers #=> Array
resp.cors.allow_headers[0] #=> String
resp.cors.allow_methods #=> Array
resp.cors.allow_methods[0] #=> String
resp.cors.allow_origins #=> Array
resp.cors.allow_origins[0] #=> String
resp.cors.expose_headers #=> Array
resp.cors.expose_headers[0] #=> String
resp.cors.max_age #=> Integer
resp.creation_time #=> Time
resp.last_modified_time #=> Time
resp.invoke_mode #=> String, one of "BUFFERED", "RESPONSE_STREAM"

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function.

    Name formats

    • Function name – my-function.

    • Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN – 123456789012:function:my-function.

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

  • :qualifier (String) —

    The alias name.

  • :auth_type (String) —

    The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Control access to Lambda function URLs.

  • :cors (Types::Cors) —

    The cross-origin resource sharing (CORS) settings for your function URL.

  • :invoke_mode (String) —

    Use one of the following options:

    • BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.

    • RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 200 MB.

Returns:

See Also:



10066
10067
10068
10069
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 10066

def update_function_url_config(params = {}, options = {})
  req = build_request(:update_function_url_config, 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
function_active #get_function_configuration 5 60
function_active_v2 #get_function 1 300
function_exists #get_function 1 20
function_updated #get_function_configuration 5 60
function_updated_v2 #get_function 1 300
published_version_active #get_function_configuration 5 312

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.



10186
10187
10188
10189
10190
 
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/client.rb', line 10186

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