libZSservicesZSamazonka-lambdaZSamazonka-lambda
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lambda.ListEventSourceMappings

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListEventSourceMappings Source #

See: newListEventSourceMappings smart constructor.

Constructors

ListEventSourceMappings' 

Fields

  • eventSourceArn :: Maybe Text

    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.
  • marker :: Maybe Text

    A pagination token returned by a previous call.

  • maxItems :: Maybe Natural

    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.

  • functionName :: Maybe Text

    The name 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.

Instances

Instances details
Eq ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Read ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Show ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Generic ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Associated Types

type Rep ListEventSourceMappings :: Type -> Type #

NFData ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Methods

rnf :: ListEventSourceMappings -> () #

Hashable ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

AWSPager ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

AWSRequest ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

ToHeaders ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

ToPath ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

ToQuery ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

type Rep ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

type Rep ListEventSourceMappings = D1 ('MetaData "ListEventSourceMappings" "Amazonka.Lambda.ListEventSourceMappings" "libZSservicesZSamazonka-lambdaZSamazonka-lambda" 'False) (C1 ('MetaCons "ListEventSourceMappings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse ListEventSourceMappings Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

newListEventSourceMappings :: ListEventSourceMappings Source #

Create a value of ListEventSourceMappings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventSourceArn:ListEventSourceMappings', listEventSourceMappings_eventSourceArn - 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.

$sel:marker:ListEventSourceMappings', listEventSourceMappings_marker - A pagination token returned by a previous call.

$sel:maxItems:ListEventSourceMappings', listEventSourceMappings_maxItems - 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.

$sel:functionName:ListEventSourceMappings', listEventSourceMappings_functionName - The name 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.

Request Lenses

listEventSourceMappings_eventSourceArn :: Lens' ListEventSourceMappings (Maybe Text) Source #

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.

listEventSourceMappings_marker :: Lens' ListEventSourceMappings (Maybe Text) Source #

A pagination token returned by a previous call.

listEventSourceMappings_maxItems :: Lens' ListEventSourceMappings (Maybe Natural) Source #

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.

listEventSourceMappings_functionName :: Lens' ListEventSourceMappings (Maybe Text) Source #

The name 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.

Destructuring the Response

data ListEventSourceMappingsResponse Source #

See: newListEventSourceMappingsResponse smart constructor.

Constructors

ListEventSourceMappingsResponse' 

Fields

Instances

Instances details
Eq ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Read ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Show ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Generic ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

Associated Types

type Rep ListEventSourceMappingsResponse :: Type -> Type #

NFData ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

type Rep ListEventSourceMappingsResponse Source # 
Instance details

Defined in Amazonka.Lambda.ListEventSourceMappings

type Rep ListEventSourceMappingsResponse = D1 ('MetaData "ListEventSourceMappingsResponse" "Amazonka.Lambda.ListEventSourceMappings" "libZSservicesZSamazonka-lambdaZSamazonka-lambda" 'False) (C1 ('MetaCons "ListEventSourceMappingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSourceMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventSourceMappingConfiguration])) :*: (S1 ('MetaSel ('Just "nextMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEventSourceMappingsResponse Source #

Create a value of ListEventSourceMappingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventSourceMappings:ListEventSourceMappingsResponse', listEventSourceMappingsResponse_eventSourceMappings - A list of event source mappings.

$sel:nextMarker:ListEventSourceMappingsResponse', listEventSourceMappingsResponse_nextMarker - A pagination token that's returned when the response doesn't contain all event source mappings.

$sel:httpStatus:ListEventSourceMappingsResponse', listEventSourceMappingsResponse_httpStatus - The response's http status code.

Response Lenses

listEventSourceMappingsResponse_nextMarker :: Lens' ListEventSourceMappingsResponse (Maybe Text) Source #

A pagination token that's returned when the response doesn't contain all event source mappings.