AWS Lambda Lambda Event Invoke Config API

openapi: 3.2.0
info:
  title: AWS Lambda Event Invoke Config API
  version: '2015-03-31'
  description: Generated from AWS's published Smithy model for AWS Lambda. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lambda.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Event Invoke Config
paths:
  /2019-09-25/functions/{FunctionName}/event-invoke-config:
    delete:
      operationId: DeleteFunctionEventInvokeConfig
      summary: Delete Function Event Invoke Config
      description: Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFunctionEventInvokeConfigRequest'
            example:
              FunctionName: my-function
              Qualifier: GREEN
      tags:
      - Event Invoke Config
    get:
      operationId: GetFunctionEventInvokeConfig
      summary: Get Function Event Invoke Config
      description: Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionEventInvokeConfig'
              example:
                DestinationConfig:
                  OnFailure:
                    Destination: arn:aws:sqs:us-east-2:123456789012:failed-invocations
                  OnSuccess: {}
                FunctionArn: arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE
                LastModified: '2016-11-21T19:49:20.006Z'
                MaximumEventAgeInSeconds: 3600
                MaximumRetryAttempts: 0
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFunctionEventInvokeConfigRequest'
            example:
              FunctionName: my-function
              Qualifier: BLUE
      tags:
      - Event Invoke Config
    put:
      operationId: PutFunctionEventInvokeConfig
      summary: Put Function Event Invoke Config
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionEventInvokeConfig'
              example:
                DestinationConfig:
                  OnFailure: {}
                  OnSuccess: {}
                FunctionArn: arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST
                LastModified: '2016-11-21T19:49:20.006Z'
                MaximumEventAgeInSeconds: 3600
                MaximumRetryAttempts: 0
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFunctionEventInvokeConfigRequest'
            example:
              FunctionName: my-function
              MaximumEventAgeInSeconds: 3600
              MaximumRetryAttempts: 0
      tags:
      - Event Invoke Config
    post:
      operationId: UpdateFunctionEventInvokeConfig
      summary: Update Function Event Invoke Config
      description: Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunctionEventInvokeConfig'
              example:
                DestinationConfig:
                  OnFailure:
                    Destination: arn:aws:sqs:us-east-2:123456789012:destination
                  OnSuccess: {}
                FunctionArn: arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST
                LastModified: 1573687896.493
                MaximumEventAgeInSeconds: 3600
                MaximumRetryAttempts: 0
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '409':
          description: ResourceConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFunctionEventInvokeConfigRequest'
            example:
              DestinationConfig:
                OnFailure:
                  Destination: arn:aws:sqs:us-east-2:123456789012:destination
              FunctionName: my-function
      tags:
      - Event Invoke Config
  /2019-09-25/functions/{FunctionName}/event-invoke-config/list:
    get:
      operationId: ListFunctionEventInvokeConfigs
      summary: List Function Event Invoke Configs
      description: Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFunctionEventInvokeConfigsResponse'
              example:
                FunctionEventInvokeConfigs:
                - FunctionArn: arn:aws:lambda:us-east-2:123456789012:function:my-function:GREEN
                  LastModified: 1577824406.719
                  MaximumEventAgeInSeconds: 1800
                  MaximumRetryAttempts: 2
                - FunctionArn: arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE
                  LastModified: 1577824396.653
                  MaximumEventAgeInSeconds: 3600
                  MaximumRetryAttempts: 0
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '500':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFunctionEventInvokeConfigsRequest'
            example:
              FunctionName: my-function
      tags:
      - Event Invoke Config
components:
  schemas:
    DeleteFunctionEventInvokeConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: 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:
          type: string
          description: A version number or alias name.
      required:
      - FunctionName
    UpdateFunctionEventInvokeConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: 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:
          type: string
          description: A version number or alias name.
        MaximumRetryAttempts:
          type: integer
          description: The maximum number of times to retry when the function returns an error.
        MaximumEventAgeInSeconds:
          type: integer
          description: The maximum age of a request that Lambda sends to a function for processing.
        DestinationConfig:
          $ref: '#/components/schemas/DestinationConfig'
      required:
      - FunctionName
    ResourceConflictException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    ListFunctionEventInvokeConfigsRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: 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:
          type: string
          description: Specify the pagination token that's returned by a previous request to retrieve the next page of results.
        MaxItems:
          type: integer
          description: The maximum number of configurations to return.
      required:
      - FunctionName
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
          description: The number of seconds the caller should wait before retrying.
        Type:
          type: string
        message:
          type: string
        Reason:
          type: string
          enum:
          - ConcurrentInvocationLimitExceeded
          - FunctionInvocationRateLimitExceeded
          - ReservedFunctionConcurrentInvocationLimitExceeded
          - ReservedFunctionInvocationRateLimitExceeded
          - CallerRateLimitExceeded
          - ConcurrentSnapshotCreateLimitExceeded
    PutFunctionEventInvokeConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: 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:
          type: string
          description: A version number or alias name.
        MaximumRetryAttempts:
          type: integer
          description: The maximum number of times to retry when the function returns an error.
        MaximumEventAgeInSeconds:
          type: integer
          description: The maximum age of a request that Lambda sends to a function for processing.
        DestinationConfig:
          $ref: '#/components/schemas/DestinationConfig'
      required:
      - FunctionName
    InvalidParameterValueException:
      type: object
      properties:
        Type:
          type: string
          description: The exception type.
        message:
          type: string
          description: The exception message.
    OnSuccess:
      type: object
      properties:
        Destination:
          type: string
          description: The Amazon Resource Name (ARN) of the destination resource. Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations.
    ResourceNotFoundException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
    GetFunctionEventInvokeConfigRequest:
      type: object
      properties:
        FunctionName:
          type: string
          description: 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:
          type: string
          description: A version number or alias name.
      required:
      - FunctionName
    ListFunctionEventInvokeConfigsResponse:
      type: object
      properties:
        FunctionEventInvokeConfigs:
          type: array
          items:
            $ref: '#/components/schemas/FunctionEventInvokeConfig'
          description: A list of configurations.
        NextMarker:
          type: string
          description: The pagination token that's included if more results are available.
    DestinationConfig:
      type: object
      properties:
        OnSuccess:
          $ref: '#/components/schemas/OnSuccess'
        OnFailure:
          $ref: '#/components/schemas/OnFailure'
    OnFailure:
      type: object
      properties:
        Destination:
          type: string
          description: The Amazon Resource Name (ARN) of the destination resource. To retain records of failed invocations from Kinesis, DynamoDB, self-managed Apache Kafka, or Amazon MSK, you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, or Kafka topic as the destination. Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations. To retain reco
    FunctionEventInvokeConfig:
      type: object
      properties:
        LastModified:
          type: string
          format: date-time
          description: The date and time that the configuration was last updated.
        FunctionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the function.
        MaximumRetryAttempts:
          type: integer
          description: The maximum number of times to retry when the function returns an error.
        MaximumEventAgeInSeconds:
          type: integer
          description: The maximum age of a request that Lambda sends to a function for processing.
        DestinationConfig:
          $ref: '#/components/schemas/DestinationConfig'
    ServiceException:
      type: object
      properties:
        Type:
          type: string
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lambda
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lambda/service/2015-03-31/lambda-2015-03-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)