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

Class: Aws::Lambda::Types::ListEventSourceMappingsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb

Overview

Note:

When making an API call, you may pass ListEventSourceMappingsRequest data as a hash:

{
  event_source_arn: "Arn",
  function_name: "FunctionName",
  marker: "String",
  max_items: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#event_source_arnString

The Amazon Resource Name (ARN) of the Amazon Kinesis stream. (This parameter is optional.)

Returns:

  • (String)


1468
1469
1470
1471
1472
1473
1474
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1468

class ListEventSourceMappingsRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :marker,
  :max_items)
  include Aws::Structure
end

#function_nameString

The name of the Lambda function.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (String)


1468
1469
1470
1471
1472
1473
1474
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1468

class ListEventSourceMappingsRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :marker,
  :max_items)
  include Aws::Structure
end

#markerString

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

Returns:

  • (String)


1468
1469
1470
1471
1472
1473
1474
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1468

class ListEventSourceMappingsRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :marker,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

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

Returns:

  • (Integer)


1468
1469
1470
1471
1472
1473
1474
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1468

class ListEventSourceMappingsRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :marker,
  :max_items)
  include Aws::Structure
end