Class: Aws::LambdaPreview::Client

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

Overview

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

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

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

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

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

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

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

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

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

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

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

  • :stub_responses (Boolean) — default: false —

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

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

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

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

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

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

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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



430
431
432
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 430

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

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



1136
1137
1138
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 1136

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

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



1139
1140
1141
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 1139

def errors_module
  Errors
end

Instance Method Details

#add_event_source(params = {}) ⇒ Types::EventSourceConfiguration

Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to [AWS Lambda: How it Works] in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.

This operation requires permission for the ‘iam:PassRole` action for the IAM role. It also requires permission for the `lambda:AddEventSource` action.

[1]: docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html

Examples:

Request syntax with placeholder values


resp = client.add_event_source({
  event_source: "String", # required
  function_name: "FunctionName", # required
  role: "RoleArn", # required
  batch_size: 1,
  parameters: {
    "String" => "String",
  },
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source #=> String
resp.function_name #=> String
resp.parameters #=> Hash
resp.parameters["String"] #=> String
resp.role #=> String
resp.last_modified #=> Time
resp.is_active #=> Boolean
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_source (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

  • :function_name (required, String) —

    The Lambda function to invoke when AWS Lambda detects an event on the stream.

  • :role (required, String) —

    The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

  • :batch_size (Integer) —

    The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

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

    A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the ‘InitialPositionInStream` key. The valid values are: “TRIM_HORIZON” and “LATEST”. The default value is “TRIM_HORIZON”. For more information, go to [ShardIteratorType] in the Amazon Kinesis Service API Reference.

    [1]: docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

Returns:

See Also:



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

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

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

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

Parameters:

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


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 1109

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

#delete_function(params = {}) ⇒ Struct

Deletes the specified Lambda function code and configuration.

This operation requires permission for the ‘lambda:DeleteFunction` action.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



561
562
563
564
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 561

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

#get_event_source(params = {}) ⇒ Types::EventSourceConfiguration

Returns configuration information for the specified event source mapping (see AddEventSource).

This operation requires permission for the ‘lambda:GetEventSource` action.

Examples:

Request syntax with placeholder values


resp = client.get_event_source({
  uuid: "String", # required
})

Response structure


resp.uuid #=> String
resp.batch_size #=> Integer
resp.event_source #=> String
resp.function_name #=> String
resp.parameters #=> Hash
resp.parameters["String"] #=> String
resp.role #=> String
resp.last_modified #=> Time
resp.is_active #=> Boolean
resp.status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The AWS Lambda assigned ID of the event source mapping.

Returns:

See Also:



610
611
612
613
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 610

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

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

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the ‘lambda:GetFunction` action.

Examples:

Request syntax with placeholder values


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

Response structure


resp.configuration.function_name #=> String
resp.configuration.function_arn #=> String
resp.configuration.configuration_id #=> String
resp.configuration.runtime #=> String, one of "nodejs"
resp.configuration.role #=> String
resp.configuration.handler #=> String
resp.configuration.mode #=> String, one of "event"
resp.configuration.code_size #=> Integer
resp.configuration.description #=> String
resp.configuration.timeout #=> Integer
resp.configuration.memory_size #=> Integer
resp.configuration.last_modified #=> Time
resp.code.repository_type #=> String
resp.code.location #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function name.

Returns:

See Also:



659
660
661
662
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 659

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

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

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.

This operation requires permission for the ‘lambda:GetFunctionConfiguration` operation.

Examples:

Request syntax with placeholder values


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

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the Lambda function for which you want to retrieve the configuration information.

Returns:

See Also:



715
716
717
718
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 715

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

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

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the ‘lambda:InvokeFunction` action.

Examples:

Request syntax with placeholder values


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

Response structure


resp.status #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The Lambda function name.

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

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

Returns:

See Also:



753
754
755
756
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 753

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

#list_event_sources(params = {}) ⇒ Types::ListEventSourcesResponse

Returns a list of event source mappings you created using the ‘AddEventSource` (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the ‘lambda:ListEventSources` action.

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_event_sources({
  event_source_arn: "String",
  function_name: "FunctionName",
  marker: "String",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.event_sources #=> Array
resp.event_sources[0].uuid #=> String
resp.event_sources[0].batch_size #=> Integer
resp.event_sources[0].event_source #=> String
resp.event_sources[0].function_name #=> String
resp.event_sources[0].parameters #=> Hash
resp.event_sources[0].parameters["String"] #=> String
resp.event_sources[0].role #=> String
resp.event_sources[0].last_modified #=> Time
resp.event_sources[0].is_active #=> Boolean
resp.event_sources[0].status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_source_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis stream.

  • :function_name (String) —

    The name of the AWS Lambda function.

  • :marker (String) —

    Optional string. An opaque pagination token returned from a previous ‘ListEventSources` operation. If present, specifies to continue the list from where the returning call left off.

  • :max_items (Integer) —

    Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

Returns:

See Also:



818
819
820
821
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 818

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

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

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the ‘lambda:ListFunctions` action.

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({
  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].configuration_id #=> String
resp.functions[0].runtime #=> String, one of "nodejs"
resp.functions[0].role #=> String
resp.functions[0].handler #=> String
resp.functions[0].mode #=> String, one of "event"
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

Parameters:

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

    ({})

Options Hash (params):

  • :marker (String) —

    Optional string. An opaque pagination token returned from a previous ‘ListFunctions` operation. If present, indicates where to continue the listing.

  • :max_items (Integer) —

    Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

Returns:

See Also:



874
875
876
877
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 874

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

#remove_event_source(params = {}) ⇒ Struct

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the ‘lambda:RemoveEventSource` action.

Examples:

Request syntax with placeholder values


resp = client.remove_event_source({
  uuid: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :uuid (required, String) —

    The event source mapping ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



900
901
902
903
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 900

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

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

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function’s code.

This operation requires permission for the ‘lambda:UpdateFunctionConfiguration` action.

Examples:

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

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name of the Lambda function.

  • :role (String) —

    The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

  • :handler (String) —

    The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

  • :description (String) —

    A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

  • :timeout (Integer) —

    The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

  • :memory_size (Integer) —

    The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

See Also:



988
989
990
991
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 988

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

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

Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.

This operation requires permission for the ‘lambda:UploadFunction` action.

Examples:

Request syntax with placeholder values


resp = client.upload_function({
  function_name: "FunctionName", # required
  function_zip: "data", # required
  runtime: "nodejs", # required, accepts nodejs
  role: "RoleArn", # required
  handler: "Handler", # required
  mode: "event", # required, accepts event
  description: "Description",
  timeout: 1,
  memory_size: 1,
})

Response structure


resp.function_name #=> String
resp.function_arn #=> String
resp.configuration_id #=> String
resp.runtime #=> String, one of "nodejs"
resp.role #=> String
resp.handler #=> String
resp.mode #=> String, one of "event"
resp.code_size #=> Integer
resp.description #=> String
resp.timeout #=> Integer
resp.memory_size #=> Integer
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :function_name (required, String) —

    The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.

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

    A .zip file containing your packaged source code. For more information about creating a .zip file, go to [AWS LambdaL How it Works] in the AWS Lambda Developer Guide.

    [1]: docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events.html

  • :runtime (required, String) —

    The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only “nodejs” as the runtime.

  • :role (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

  • :handler (required, String) —

    The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

  • :mode (required, String) —

    How the Lambda function will be invoked. Lambda supports only the “event” mode.

  • :description (String) —

    A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

  • :timeout (Integer) —

    The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

  • :memory_size (Integer) —

    The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

See Also:



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

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

#waiter_names ⇒ Object

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

Deprecated. 


1129
1130
1131
 
# File 'lib/aws-sdk-lambdapreview/client.rb', line 1129

def waiter_names
  []
end