openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 2015 03 31 API description: Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: 2015 03 31 paths: /2015-03-31/functions/{FunctionName}/policy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: AddPermission description: '

Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization 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, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web 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.

' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/AddPermissionResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: PolicyLengthExceededException content: application/json: schema: $ref: '#/components/schemas/PolicyLengthExceededException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Qualifier in: query required: false description: Specify a version or alias to add permissions to a published version of the function. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - StatementId - Action - Principal properties: StatementId: description: A statement identifier that differentiates the statement from others in the same policy. type: string pattern: ([a-zA-Z0-9-_]+) minLength: 1 maxLength: 100 Action: description: The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction. type: string pattern: (lambda:[*]|lambda:[a-zA-Z]+|[*]) Principal: description: The Amazon Web Service or Amazon Web Services account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service. type: string pattern: '[^\s]+' SourceArn: description:

For Amazon Web 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.

type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) SourceAccount: description: For Amazon Web 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. type: string pattern: \d{12} maxLength: 12 EventSourceToken: description: For Alexa Smart Home functions, a token that the invoker must supply. type: string pattern: '[a-zA-Z0-9._\-]+' minLength: 0 maxLength: 256 RevisionId: description: 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. type: string PrincipalOrgID: description: The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization. type: string pattern: ^o-[a-z0-9]{10,32}$ minLength: 12 maxLength: 34 FunctionUrlAuthType: description: 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 Security and auth model for Lambda function URLs. type: string enum: - NONE - AWS_IAM tags: - 2015 03 31 get: operationId: GetPolicy description: Returns the resource-based IAM policy for a function, version, or alias. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetPolicyResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 - name: Qualifier in: query required: false description: Specify a version or alias to get the policy for that resource. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/aliases: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateAlias description:

Creates an alias for a Lambda 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.

responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/AliasConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 requestBody: required: true content: application/json: schema: type: object required: - Name - FunctionVersion properties: Name: description: The name of the alias. type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+) minLength: 1 maxLength: 128 FunctionVersion: description: The function version that the alias invokes. type: string pattern: (\$LATEST|[0-9]+) minLength: 1 maxLength: 1024 Description: description: A description of the alias. type: string minLength: 0 maxLength: 256 RoutingConfig: description: The traffic-shifting configuration of a Lambda function alias. type: object properties: AdditionalVersionWeights: allOf: - $ref: '#/components/schemas/AdditionalVersionWeights' - description: The second version, and the percentage of traffic that's routed to it. tags: - 2015 03 31 get: operationId: ListAliases description: Returns a list of aliases for a Lambda function. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAliasesResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: FunctionVersion in: query required: false description: Specify a function version to only list aliases that invoke that version. schema: type: string pattern: (\$LATEST|[0-9]+) minLength: 1 maxLength: 1024 - name: Marker in: query required: false description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. schema: type: string - name: MaxItems in: query required: false description: Limit the number of aliases returned. schema: type: integer minimum: 1 maximum: 10000 tags: - 2015 03 31 /2015-03-31/event-source-mappings/: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateEventSourceMapping description:

Creates a mapping between an event source and an Lambda 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 only for stream sources (DynamoDB and Kinesis):

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

responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - FunctionName properties: EventSourceArn: description:

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

type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) FunctionName: description:

The name of the Lambda function.

Name formats

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

type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 Enabled: description: '

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

Default: True

' type: boolean BatchSize: description:

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).

type: integer minimum: 1 maximum: 10000 FilterCriteria: description: ' An object that contains the filters for an event source. ' type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' MaximumBatchingWindowInSeconds: description: '

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 streams 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 streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

' type: integer minimum: 0 maximum: 300 ParallelizationFactor: description: (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently. type: integer minimum: 1 maximum: 10 StartingPosition: description: The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams and Amazon DocumentDB. type: string enum: - TRIM_HORIZON - LATEST - AT_TIMESTAMP StartingPositionTimestamp: description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. type: string format: date-time DestinationConfig: description: A configuration object that specifies the destination of an event after Lambda processes it. type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. MaximumRecordAgeInSeconds: description: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1). type: integer minimum: -1 maximum: 604800 BisectBatchOnFunctionError: description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. type: boolean MaximumRetryAttempts: description: (Kinesis and DynamoDB Streams only) 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. type: integer minimum: -1 maximum: 10000 TumblingWindowInSeconds: description: (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. type: integer minimum: 0 maximum: 900 Topics: description: The name of the Kafka topic. type: array items: $ref: '#/components/schemas/Topic' minItems: 1 maxItems: 1 Queues: description: ' (MQ) The name of the Amazon MQ broker destination queue to consume. ' type: array items: $ref: '#/components/schemas/Queue' minItems: 1 maxItems: 1 SourceAccessConfigurations: description: An array of authentication protocols or VPC components required to secure your event source. type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 SelfManagedEventSource: description: The self-managed Apache Kafka cluster for your event source. type: object properties: Endpoints: allOf: - $ref: '#/components/schemas/Endpoints' - description: 'The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].' FunctionResponseTypes: description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 AmazonManagedKafkaEventSourceConfig: description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID. SelfManagedKafkaEventSourceConfig: description: Specific configuration settings for a self-managed Apache Kafka event source. type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID. ScalingConfig: description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. DocumentDBEventSourceConfig: description: ' Specific configuration settings for a DocumentDB event source. ' type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' tags: - 2015 03 31 get: operationId: ListEventSourceMappings description: Lists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEventSourceMappingsResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: EventSourceArn in: query required: false description:

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

schema: type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) - name: FunctionName in: query required: false description:

The name of the Lambda function.

Name formats

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

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Marker in: query required: false description: A pagination token returned by a previous call. schema: type: string - name: MaxItems in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 10000 tags: - 2015 03 31 /2015-03-31/functions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateFunction description:

Creates a Lambda 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, 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 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, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '485': description: CodeStorageExceededException content: application/json: schema: $ref: '#/components/schemas/CodeStorageExceededException' '486': description: CodeVerificationFailedException content: application/json: schema: $ref: '#/components/schemas/CodeVerificationFailedException' '487': description: InvalidCodeSignatureException content: application/json: schema: $ref: '#/components/schemas/InvalidCodeSignatureException' '488': description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: '#/components/schemas/CodeSigningConfigNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - FunctionName - Role - Code properties: FunctionName: description:

The name of the Lambda function.

Name 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.

type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 Runtime: description:

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

type: string enum: - nodejs - nodejs4.3 - nodejs6.10 - nodejs8.10 - nodejs10.x - nodejs12.x - nodejs14.x - nodejs16.x - java8 - java8.al2 - java11 - python2.7 - python3.6 - python3.7 - python3.8 - python3.9 - dotnetcore1.0 - dotnetcore2.0 - dotnetcore2.1 - dotnetcore3.1 - dotnet6 - nodejs4.3-edge - go1.x - ruby2.5 - ruby2.7 - provided - provided.al2 - nodejs18.x - python3.10 Role: description: The Amazon Resource Name (ARN) of the function's execution role. type: string pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Handler: description: 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. type: string pattern: '[^\s]+' maxLength: 128 Code: description: The code for the Lambda function. You can either specify an object in Amazon S3, upload a .zip file archive deployment package directly, or specify the URI of a container image. type: object properties: ZipFile: allOf: - $ref: '#/components/schemas/Blob' - description: The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for you. S3Bucket: allOf: - $ref: '#/components/schemas/S3Bucket' - description: 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. S3Key: allOf: - $ref: '#/components/schemas/S3Key' - description: The Amazon S3 key of the deployment package. S3ObjectVersion: allOf: - $ref: '#/components/schemas/S3ObjectVersion' - description: For versioned objects, the version of the deployment package object to use. ImageUri: allOf: - $ref: '#/components/schemas/String' - description: URI of a container image in the Amazon ECR registry. Description: description: A description of the function. type: string minLength: 0 maxLength: 256 Timeout: description: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment. type: integer minimum: 1 MemorySize: description: 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. type: integer minimum: 128 maximum: 10240 Publish: description: Set to true to publish the first version of the function during creation. type: boolean VpcConfig: description: The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC. type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: A list of VPC subnet IDs. SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: A list of VPC security group IDs. PackageType: description: The type of deployment package. Set to Image for container image and set to Zip for .zip file archive. type: string enum: - Zip - Image DeadLetterConfig: description: The dead-letter queue for failed asynchronous invocations. type: object properties: TargetArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. Environment: description: A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. type: object properties: Variables: allOf: - $ref: '#/components/schemas/EnvironmentVariables' - description: Environment variable key-value pairs. For more information, see Using Lambda environment variables. KMSKeyArn: description: The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key. type: string pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() TracingConfig: description: The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active. type: object properties: Mode: allOf: - $ref: '#/components/schemas/TracingMode' - description: The tracing mode. Tags: description: A list of tags to apply to the function. type: object additionalProperties: $ref: '#/components/schemas/TagValue' Layers: description: A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. type: array items: $ref: '#/components/schemas/LayerVersionArn' FileSystemConfigs: description: Connection settings for an Amazon EFS file system. type: array items: $ref: '#/components/schemas/FileSystemConfig' maxItems: 1 ImageConfig: description: Configuration values that override the container image Dockerfile settings. For more information, see Container image settings. type: object properties: EntryPoint: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the entry point to their application, which is typically the location of the runtime executable. Command: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies parameters that you want to pass in with ENTRYPOINT. WorkingDirectory: allOf: - $ref: '#/components/schemas/WorkingDirectory' - description: Specifies the working directory. CodeSigningConfigArn: description: 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. type: string pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:code-signing-config:csc-[a-z0-9]{17} maxLength: 200 Architectures: description: 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. type: array items: $ref: '#/components/schemas/Architecture' minItems: 1 maxItems: 1 EphemeralStorage: description: The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. type: object properties: Size: allOf: - $ref: '#/components/schemas/EphemeralStorageSize' - description: The size of the function's /tmp directory. SnapStart: description:

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

SnapStart is supported with the java11 runtime. For more information, see Improving startup performance with Lambda SnapStart.

type: object properties: ApplyOn: allOf: - $ref: '#/components/schemas/SnapStartApplyOn' - description: Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/aliases/{Name}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteAlias description: Deletes a Lambda function alias. responses: '204': description: Success '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Name in: path required: true description: The name of the alias. schema: type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 get: operationId: GetAlias description: Returns details about a Lambda function alias. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AliasConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Name in: path required: true description: The name of the alias. schema: type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 put: operationId: UpdateAlias description: Updates the configuration of a Lambda function alias. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AliasConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' '485': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Name in: path required: true description: The name of the alias. schema: type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: FunctionVersion: description: The function version that the alias invokes. type: string pattern: (\$LATEST|[0-9]+) minLength: 1 maxLength: 1024 Description: description: A description of the alias. type: string minLength: 0 maxLength: 256 RoutingConfig: description: The traffic-shifting configuration of a Lambda function alias. type: object properties: AdditionalVersionWeights: allOf: - $ref: '#/components/schemas/AdditionalVersionWeights' - description: The second version, and the percentage of traffic that's routed to it. RevisionId: description: 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. type: string tags: - 2015 03 31 /2015-03-31/event-source-mappings/{UUID}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteEventSourceMapping description:

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.

responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string tags: - 2015 03 31 get: operationId: GetEventSourceMapping description: Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string tags: - 2015 03 31 put: operationId: UpdateEventSourceMapping description:

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 only for stream sources (DynamoDB and Kinesis):

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

responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/EventSourceMappingConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '485': description: ResourceInUseException content: application/json: schema: $ref: '#/components/schemas/ResourceInUseException' parameters: - name: UUID in: path required: true description: The identifier of the event source mapping. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: FunctionName: description:

The name of the Lambda function.

Name formats

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

type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 Enabled: description: '

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

Default: True

' type: boolean BatchSize: description:

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).

type: integer minimum: 1 maximum: 10000 FilterCriteria: description: ' An object that contains the filters for an event source. ' type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' MaximumBatchingWindowInSeconds: description: '

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 streams 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 streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

' type: integer minimum: 0 maximum: 300 DestinationConfig: description: A configuration object that specifies the destination of an event after Lambda processes it. type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. MaximumRecordAgeInSeconds: description: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1). type: integer minimum: -1 maximum: 604800 BisectBatchOnFunctionError: description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. type: boolean MaximumRetryAttempts: description: (Kinesis and DynamoDB Streams only) 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. type: integer minimum: -1 maximum: 10000 ParallelizationFactor: description: (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently. type: integer minimum: 1 maximum: 10 SourceAccessConfigurations: description: An array of authentication protocols or VPC components required to secure your event source. type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 TumblingWindowInSeconds: description: (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. type: integer minimum: 0 maximum: 900 FunctionResponseTypes: description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 ScalingConfig: description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. DocumentDBEventSourceConfig: description: ' Specific configuration settings for a DocumentDB event source. ' type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteFunction description:

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.

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

responses: '204': description: Success '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function or version.

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: Qualifier in: query required: false description: Specify a version to delete. You can't delete a version that an alias references. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 get: operationId: GetFunction description: Returns information about the 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetFunctionResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 - name: Qualifier in: query required: false description: Specify a version or alias to get details about a published version of the function. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/configuration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetFunctionConfiguration description:

Returns the version-specific settings of a Lambda 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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 - name: Qualifier in: query required: false description: Specify a version or alias to get details about a published version of the function. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2015 03 31 put: operationId: UpdateFunctionConfiguration description:

Modify the version-specific settings of a Lambda 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 Service, use AddPermission.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '485': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' '486': description: CodeVerificationFailedException content: application/json: schema: $ref: '#/components/schemas/CodeVerificationFailedException' '487': description: InvalidCodeSignatureException content: application/json: schema: $ref: '#/components/schemas/InvalidCodeSignatureException' '488': description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: '#/components/schemas/CodeSigningConfigNotFoundException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 requestBody: required: true content: application/json: schema: type: object properties: Role: description: The Amazon Resource Name (ARN) of the function's execution role. type: string pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ Handler: description: 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. type: string pattern: '[^\s]+' maxLength: 128 Description: description: A description of the function. type: string minLength: 0 maxLength: 256 Timeout: description: The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see Lambda execution environment. type: integer minimum: 1 MemorySize: description: 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. type: integer minimum: 128 maximum: 10240 VpcConfig: description: The VPC security groups and subnets that are attached to a Lambda function. For more information, see Configuring a Lambda function to access resources in a VPC. type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: A list of VPC subnet IDs. SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: A list of VPC security group IDs. Environment: description: A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. type: object properties: Variables: allOf: - $ref: '#/components/schemas/EnvironmentVariables' - description: Environment variable key-value pairs. For more information, see Using Lambda environment variables. Runtime: description:

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

type: string enum: - nodejs - nodejs4.3 - nodejs6.10 - nodejs8.10 - nodejs10.x - nodejs12.x - nodejs14.x - nodejs16.x - java8 - java8.al2 - java11 - python2.7 - python3.6 - python3.7 - python3.8 - python3.9 - dotnetcore1.0 - dotnetcore2.0 - dotnetcore2.1 - dotnetcore3.1 - dotnet6 - nodejs4.3-edge - go1.x - ruby2.5 - ruby2.7 - provided - provided.al2 - nodejs18.x - python3.10 DeadLetterConfig: description: The dead-letter queue for failed asynchronous invocations. type: object properties: TargetArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. KMSKeyArn: description: The ARN of the Key Management Service (KMS) customer managed key that's used to encrypt your function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt your function's snapshot. If you don't provide a customer managed key, Lambda uses a default service key. type: string pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() TracingConfig: description: The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active. type: object properties: Mode: allOf: - $ref: '#/components/schemas/TracingMode' - description: The tracing mode. RevisionId: description: 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. type: string Layers: description: A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version. type: array items: $ref: '#/components/schemas/LayerVersionArn' FileSystemConfigs: description: Connection settings for an Amazon EFS file system. type: array items: $ref: '#/components/schemas/FileSystemConfig' maxItems: 1 ImageConfig: description: Configuration values that override the container image Dockerfile settings. For more information, see Container image settings. type: object properties: EntryPoint: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the entry point to their application, which is typically the location of the runtime executable. Command: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies parameters that you want to pass in with ENTRYPOINT. WorkingDirectory: allOf: - $ref: '#/components/schemas/WorkingDirectory' - description: Specifies the working directory. EphemeralStorage: description: The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. type: object properties: Size: allOf: - $ref: '#/components/schemas/EphemeralStorageSize' - description: The size of the function's /tmp directory. SnapStart: description:

The function's Lambda SnapStart setting. Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.

SnapStart is supported with the java11 runtime. For more information, see Improving startup performance with Lambda SnapStart.

type: object properties: ApplyOn: allOf: - $ref: '#/components/schemas/SnapStartApplyOn' - description: Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/invocations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: Invoke description:

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.

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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InvocationResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidRequestContentException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestContentException' '483': description: RequestTooLargeException content: application/json: schema: $ref: '#/components/schemas/RequestTooLargeException' '484': description: UnsupportedMediaTypeException content: application/json: schema: $ref: '#/components/schemas/UnsupportedMediaTypeException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '487': description: EC2UnexpectedException content: application/json: schema: $ref: '#/components/schemas/EC2UnexpectedException' '488': description: SubnetIPAddressLimitReachedException content: application/json: schema: $ref: '#/components/schemas/SubnetIPAddressLimitReachedException' '489': description: ENILimitReachedException content: application/json: schema: $ref: '#/components/schemas/ENILimitReachedException' '490': description: EFSMountConnectivityException content: application/json: schema: $ref: '#/components/schemas/EFSMountConnectivityException' '491': description: EFSMountFailureException content: application/json: schema: $ref: '#/components/schemas/EFSMountFailureException' '492': description: EFSMountTimeoutException content: application/json: schema: $ref: '#/components/schemas/EFSMountTimeoutException' '493': description: EFSIOException content: application/json: schema: $ref: '#/components/schemas/EFSIOException' '494': description: SnapStartException content: application/json: schema: $ref: '#/components/schemas/SnapStartException' '495': description: SnapStartTimeoutException content: application/json: schema: $ref: '#/components/schemas/SnapStartTimeoutException' '496': description: SnapStartNotReadyException content: application/json: schema: $ref: '#/components/schemas/SnapStartNotReadyException' '497': description: EC2ThrottledException content: application/json: schema: $ref: '#/components/schemas/EC2ThrottledException' '498': description: EC2AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/EC2AccessDeniedException' '499': description: InvalidSubnetIDException content: application/json: schema: $ref: '#/components/schemas/InvalidSubnetIDException' '500': description: InvalidSecurityGroupIDException content: application/json: schema: $ref: '#/components/schemas/InvalidSecurityGroupIDException' '501': description: InvalidZipFileException content: application/json: schema: $ref: '#/components/schemas/InvalidZipFileException' '502': description: KMSDisabledException content: application/json: schema: $ref: '#/components/schemas/KMSDisabledException' '503': description: KMSInvalidStateException content: application/json: schema: $ref: '#/components/schemas/KMSInvalidStateException' '504': description: KMSAccessDeniedException content: application/json: schema: $ref: '#/components/schemas/KMSAccessDeniedException' '505': description: KMSNotFoundException content: application/json: schema: $ref: '#/components/schemas/KMSNotFoundException' '506': description: InvalidRuntimeException content: application/json: schema: $ref: '#/components/schemas/InvalidRuntimeException' '507': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '508': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 - name: X-Amz-Invocation-Type in: header required: false description:

Choose from the following options.

schema: type: string enum: - Event - RequestResponse - DryRun - name: X-Amz-Log-Type in: header required: false description: Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only. schema: type: string enum: - None - Tail - name: X-Amz-Client-Context in: header required: false description: Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. schema: type: string - name: Qualifier in: query required: false description: Specify a version or alias to invoke a published version of the function. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: Payload: description: '

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.

' type: string format: password tags: - 2015 03 31 /2015-03-31/functions/: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListFunctions description:

Returns a list of Lambda 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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListFunctionsResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' parameters: - name: MasterRegion in: query required: false description: 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. schema: type: string pattern: ALL|[a-z]{2}(-gov)?-[a-z]+-\d{1} - name: FunctionVersion in: query required: false description: Set to ALL to include entries for all published versions of each function. schema: type: string enum: - ALL - name: Marker in: query required: false description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. schema: type: string - name: MaxItems in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 10000 tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListVersionsByFunction description: Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVersionsByFunctionResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 - name: Marker in: query required: false description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. schema: type: string - name: MaxItems in: query required: false description: 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. schema: type: integer minimum: 1 maximum: 10000 tags: - 2015 03 31 post: operationId: PublishVersion description:

Creates a version from the current code and configuration of a 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.

responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: CodeStorageExceededException content: application/json: schema: $ref: '#/components/schemas/CodeStorageExceededException' '485': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' '486': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 requestBody: required: true content: application/json: schema: type: object properties: CodeSha256: description: 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. type: string Description: description: A description for the version to override the description in the function configuration. type: string minLength: 0 maxLength: 256 RevisionId: description: 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. type: string tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/policy/{StatementId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: RemovePermission description: Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy. responses: '204': description: Success '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' parameters: - name: FunctionName in: path required: true description:

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

Name formats

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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 - name: StatementId in: path required: true description: Statement ID of the permission to remove. schema: type: string pattern: ([a-zA-Z0-9-_.]+) minLength: 1 maxLength: 100 - name: Qualifier in: query required: false description: Specify a version or alias to remove permissions from a published version of the function. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 - name: RevisionId in: query required: false description: 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. schema: type: string tags: - 2015 03 31 /2015-03-31/functions/{FunctionName}/code: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateFunctionCode description:

Updates a Lambda 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.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: CodeStorageExceededException content: application/json: schema: $ref: '#/components/schemas/CodeStorageExceededException' '485': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' '486': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '487': description: CodeVerificationFailedException content: application/json: schema: $ref: '#/components/schemas/CodeVerificationFailedException' '488': description: InvalidCodeSignatureException content: application/json: schema: $ref: '#/components/schemas/InvalidCodeSignatureException' '489': description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: '#/components/schemas/CodeSigningConfigNotFoundException' parameters: - name: FunctionName in: path required: true description:

The name of the Lambda function.

Name 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.

schema: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 140 requestBody: required: true content: application/json: schema: type: object properties: ZipFile: description: 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. type: string format: password S3Bucket: description: 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. type: string pattern: ^[0-9A-Za-z\.\-_]*(?PublishVersion separately. type: boolean DryRun: description: Set to true to validate the request parameters and access permissions without modifying the function code. type: boolean RevisionId: description: 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. type: string Architectures: description: 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. type: array items: $ref: '#/components/schemas/Architecture' minItems: 1 maxItems: 1 tags: - 2015 03 31 components: schemas: ImageConfigError: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/String' - description: Error code. Message: allOf: - $ref: '#/components/schemas/SensitiveString' - description: Error message. description: Error response to GetFunctionConfiguration. EnvironmentError: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/String' - description: The error code. Message: allOf: - $ref: '#/components/schemas/SensitiveString' - description: The error message. description: Error messages for environment variables that couldn't be applied. KMSInvalidStateException: {} TooManyRequestsException: {} EFSMountFailureException: {} ReservedConcurrentExecutions: type: integer minimum: 0 FileSystemConfig: type: object required: - Arn - LocalMountPath properties: Arn: allOf: - $ref: '#/components/schemas/FileSystemArn' - description: The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. LocalMountPath: allOf: - $ref: '#/components/schemas/LocalMountPath' - description: The path where the function can access the file system, starting with /mnt/. description: Details about the connection between a Lambda function and an Amazon EFS file system. LocalMountPath: type: string pattern: ^/mnt/[a-zA-Z0-9-_.]+$ maxLength: 160 MaximumConcurrency: type: integer minimum: 2 maximum: 1000 SnapStartResponse: type: object properties: ApplyOn: allOf: - $ref: '#/components/schemas/SnapStartApplyOn' - description: When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version. OptimizationStatus: allOf: - $ref: '#/components/schemas/SnapStartOptimizationStatus' - description: When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version. description: The function's SnapStart setting. AliasConfiguration: type: object properties: AliasArn: allOf: - $ref: '#/components/schemas/FunctionArn' - description: The Amazon Resource Name (ARN) of the alias. Name: allOf: - $ref: '#/components/schemas/Alias' - description: The name of the alias. FunctionVersion: allOf: - $ref: '#/components/schemas/Version' - description: The function version that the alias invokes. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the alias. RoutingConfig: allOf: - $ref: '#/components/schemas/AliasRoutingConfiguration' - description: The routing configuration of the alias. RevisionId: allOf: - $ref: '#/components/schemas/String' - description: A unique identifier that changes when you update the alias. description: Provides configuration information about a Lambda function alias. EventSourceMappingConfiguration: type: object properties: UUID: allOf: - $ref: '#/components/schemas/String' - description: The identifier of the event source mapping. StartingPosition: allOf: - $ref: '#/components/schemas/EventSourcePosition' - description: The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams and Amazon DocumentDB. StartingPositionTimestamp: allOf: - $ref: '#/components/schemas/Date' - description: With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. BatchSize: allOf: - $ref: '#/components/schemas/BatchSize' - description: '

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).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

' MaximumBatchingWindowInSeconds: allOf: - $ref: '#/components/schemas/MaximumBatchingWindowInSeconds' - description: '

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 streams 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 streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

' ParallelizationFactor: allOf: - $ref: '#/components/schemas/ParallelizationFactor' - description: (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. EventSourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the event source. FilterCriteria: allOf: - $ref: '#/components/schemas/FilterCriteria' - description: An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering. FunctionArn: allOf: - $ref: '#/components/schemas/FunctionArn' - description: The ARN of the Lambda function. LastModified: allOf: - $ref: '#/components/schemas/Date' - description: The date that the event source mapping was last updated or that its state changed. LastProcessingResult: allOf: - $ref: '#/components/schemas/String' - description: The result of the last Lambda invocation of your function. State: allOf: - $ref: '#/components/schemas/String' - description: 'The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.' StateTransitionReason: allOf: - $ref: '#/components/schemas/String' - description: Indicates whether a user or Lambda made the last change to the event source mapping. DestinationConfig: allOf: - $ref: '#/components/schemas/DestinationConfig' - description: (Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records. Topics: allOf: - $ref: '#/components/schemas/Topics' - description: The name of the Kafka topic. Queues: allOf: - $ref: '#/components/schemas/Queues' - description: ' (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.' SourceAccessConfigurations: allOf: - $ref: '#/components/schemas/SourceAccessConfigurations' - description: An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. SelfManagedEventSource: allOf: - $ref: '#/components/schemas/SelfManagedEventSource' - description: The self-managed Apache Kafka cluster for your event source. MaximumRecordAgeInSeconds: allOf: - $ref: '#/components/schemas/MaximumRecordAgeInSeconds' - description:

(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

The minimum value that can be set is 60 seconds.

BisectBatchOnFunctionError: allOf: - $ref: '#/components/schemas/BisectBatchOnFunctionError' - description: (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. MaximumRetryAttempts: allOf: - $ref: '#/components/schemas/MaximumRetryAttemptsEventSourceMapping' - description: (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source. TumblingWindowInSeconds: allOf: - $ref: '#/components/schemas/TumblingWindowInSeconds' - description: (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. FunctionResponseTypes: allOf: - $ref: '#/components/schemas/FunctionResponseTypeList' - description: (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. AmazonManagedKafkaEventSourceConfig: allOf: - $ref: '#/components/schemas/AmazonManagedKafkaEventSourceConfig' - description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. SelfManagedKafkaEventSourceConfig: allOf: - $ref: '#/components/schemas/SelfManagedKafkaEventSourceConfig' - description: Specific configuration settings for a self-managed Apache Kafka event source. ScalingConfig: allOf: - $ref: '#/components/schemas/ScalingConfig' - description: (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources. DocumentDBEventSourceConfig: allOf: - $ref: '#/components/schemas/DocumentDBEventSourceConfig' - description: Specific configuration settings for a DocumentDB event source. description: A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping. GetPolicyResponse: type: object properties: Policy: allOf: - $ref: '#/components/schemas/String' - description: The resource-based policy. RevisionId: allOf: - $ref: '#/components/schemas/String' - description: A unique identifier for the current revision of the policy. CodeVerificationFailedException: {} MaximumRecordAgeInSeconds: type: integer minimum: -1 maximum: 604800 Layer: type: object properties: Arn: allOf: - $ref: '#/components/schemas/LayerVersionArn' - description: The Amazon Resource Name (ARN) of the function layer. CodeSize: allOf: - $ref: '#/components/schemas/Long' - description: The size of the layer archive in bytes. SigningProfileVersionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) for a signing profile version. SigningJobArn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of a signing job. description: An Lambda layer. Timestamp: type: string GetFunctionResponse: type: object properties: Configuration: allOf: - $ref: '#/components/schemas/FunctionConfiguration' - description: The configuration of the function or version. Code: allOf: - $ref: '#/components/schemas/FunctionCodeLocation' - description: The deployment package of the function or version. Tags: allOf: - $ref: '#/components/schemas/Tags' - description: The function's tags. Concurrency: allOf: - $ref: '#/components/schemas/Concurrency' - description: The function's reserved concurrency. SensitiveString: type: string format: password Pattern: type: string pattern: .* minLength: 0 maxLength: 4096 VpcId: type: string VpcConfigResponse: type: object properties: SubnetIds: allOf: - $ref: '#/components/schemas/SubnetIds' - description: A list of VPC subnet IDs. SecurityGroupIds: allOf: - $ref: '#/components/schemas/SecurityGroupIds' - description: A list of VPC security group IDs. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The ID of the VPC. description: The VPC security groups and subnets that are attached to a Lambda function. URI: type: string pattern: '[a-zA-Z0-9-\/*:_+=.@-]*' minLength: 1 maxLength: 200 ResourceConflictException: {} DatabaseName: type: string pattern: '[^ /\.$\x22]*' minLength: 1 maxLength: 63 InvalidParameterValueException: {} ENILimitReachedException: {} Topic: type: string pattern: ^[^.]([a-zA-Z0-9\-_.]+) minLength: 1 maxLength: 249 EphemeralStorageSize: type: integer minimum: 512 maximum: 10240 EnvironmentVariableValue: type: string format: password AmazonManagedKafkaEventSourceConfig: type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID. description: Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. SnapStartTimeoutException: {} EndpointLists: type: array items: $ref: '#/components/schemas/Endpoint' minItems: 1 maxItems: 10 ListEventSourceMappingsResponse: type: object properties: NextMarker: allOf: - $ref: '#/components/schemas/String' - description: A pagination token that's returned when the response doesn't contain all event source mappings. EventSourceMappings: allOf: - $ref: '#/components/schemas/EventSourceMappingsList' - description: A list of event source mappings. CollectionName: type: string pattern: (^(?!(system\x2e)))(^[_a-zA-Z0-9])([^$]*) minLength: 1 maxLength: 57 EphemeralStorage: type: object required: - Size properties: Size: allOf: - $ref: '#/components/schemas/EphemeralStorageSize' - description: The size of the function's /tmp directory. description: The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. InvalidRuntimeException: {} SourceAccessType: type: string enum: - 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 Filter: type: object properties: Pattern: allOf: - $ref: '#/components/schemas/Pattern' - description: ' A filter pattern. For more information on the syntax of a filter pattern, see Filter rule syntax. ' description: ' A structure within a FilterCriteria object that defines an event filtering pattern. ' SelfManagedKafkaEventSourceConfig: type: object properties: ConsumerGroupId: allOf: - $ref: '#/components/schemas/URI' - description: The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID. description: Specific configuration settings for a self-managed Apache Kafka event source. FunctionResponseTypeList: type: array items: $ref: '#/components/schemas/FunctionResponseType' minItems: 0 maxItems: 1 CodeStorageExceededException: {} Queue: type: string pattern: '[\s\S]*' minLength: 1 maxLength: 1000 Endpoint: type: string pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5} minLength: 1 maxLength: 300 ListAliasesResponse: type: object properties: NextMarker: allOf: - $ref: '#/components/schemas/String' - description: The pagination token that's included if more results are available. Aliases: allOf: - $ref: '#/components/schemas/AliasList' - description: A list of aliases. FunctionCodeLocation: type: object properties: RepositoryType: allOf: - $ref: '#/components/schemas/String' - description: The service that's hosting the file. Location: allOf: - $ref: '#/components/schemas/String' - description: A presigned URL that you can use to download the deployment package. ImageUri: allOf: - $ref: '#/components/schemas/String' - description: URI of a container image in the Amazon ECR registry. ResolvedImageUri: allOf: - $ref: '#/components/schemas/String' - description: The resolved URI for the image. description: Details about a function's deployment package. Endpoints: type: object minProperties: 1 maxProperties: 2 additionalProperties: $ref: '#/components/schemas/EndpointLists' EnvironmentVariables: type: object additionalProperties: $ref: '#/components/schemas/EnvironmentVariableValue' StringList: type: array items: $ref: '#/components/schemas/String' maxItems: 1500 Version: type: string pattern: (\$LATEST|[0-9]+) minLength: 1 maxLength: 1024 ResourceNotReadyException: {} TracingConfigResponse: type: object properties: Mode: allOf: - $ref: '#/components/schemas/TracingMode' - description: The tracing mode. description: The function's X-Ray tracing configuration. StateReasonCode: type: string enum: - Idle - Creating - Restoring - EniLimitExceeded - InsufficientRolePermissions - InvalidConfiguration - InternalError - SubnetOutOfIPAddresses - InvalidSubnet - InvalidSecurityGroup - ImageDeleted - ImageAccessDenied - InvalidImage - KMSKeyAccessDenied - KMSKeyNotFound - InvalidStateKMSKey - DisabledKMSKey - EFSIOError - EFSMountConnectivityError - EFSMountFailure - EFSMountTimeout - InvalidRuntime - InvalidZipFileException - FunctionError FunctionArn: type: string pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))? SecurityGroupId: type: string NameSpacedFunctionArn: type: string pattern: arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))? Topics: type: array items: $ref: '#/components/schemas/Topic' minItems: 1 maxItems: 1 Arn: type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) AliasList: type: array items: $ref: '#/components/schemas/AliasConfiguration' SnapStartApplyOn: type: string enum: - PublishedVersions - None S3Key: type: string minLength: 1 maxLength: 1024 SecurityGroupIds: type: array items: $ref: '#/components/schemas/SecurityGroupId' maxItems: 5 FunctionConfiguration: type: object properties: FunctionName: allOf: - $ref: '#/components/schemas/NamespacedFunctionName' - description: The name of the function. FunctionArn: allOf: - $ref: '#/components/schemas/NameSpacedFunctionArn' - description: The function's Amazon Resource Name (ARN). Runtime: allOf: - $ref: '#/components/schemas/Runtime' - description:

The identifier of the function's runtime. Runtime is required if the deployment package is a .zip file archive.

The following list includes deprecated runtimes. For more information, see Runtime deprecation policy.

Role: allOf: - $ref: '#/components/schemas/RoleArn' - description: The function's execution role. Handler: allOf: - $ref: '#/components/schemas/Handler' - description: The function that Lambda calls to begin running your function. CodeSize: allOf: - $ref: '#/components/schemas/Long' - description: The size of the function's deployment package, in bytes. Description: allOf: - $ref: '#/components/schemas/Description' - description: The function's description. Timeout: allOf: - $ref: '#/components/schemas/Timeout' - description: The amount of time in seconds that Lambda allows a function to run before stopping it. MemorySize: allOf: - $ref: '#/components/schemas/MemorySize' - description: The amount of memory available to the function at runtime. LastModified: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD). CodeSha256: allOf: - $ref: '#/components/schemas/String' - description: The SHA256 hash of the function's deployment package. Version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the Lambda function. VpcConfig: allOf: - $ref: '#/components/schemas/VpcConfigResponse' - description: The function's networking configuration. DeadLetterConfig: allOf: - $ref: '#/components/schemas/DeadLetterConfig' - description: The function's dead letter queue. Environment: allOf: - $ref: '#/components/schemas/EnvironmentResponse' - description: The function's environment variables. Omitted from CloudTrail logs. KMSKeyArn: allOf: - $ref: '#/components/schemas/KMSKeyArn' - description: The KMS key that's used to encrypt the function's environment variables. When Lambda SnapStart is activated, this key is also used to encrypt the function's snapshot. This key is returned only if you've configured a customer managed key. TracingConfig: allOf: - $ref: '#/components/schemas/TracingConfigResponse' - description: The function's X-Ray tracing configuration. MasterArn: allOf: - $ref: '#/components/schemas/FunctionArn' - description: For Lambda@Edge functions, the ARN of the main function. RevisionId: allOf: - $ref: '#/components/schemas/String' - description: The latest updated revision of the function or alias. Layers: allOf: - $ref: '#/components/schemas/LayersReferenceList' - description: The function's layers. State: allOf: - $ref: '#/components/schemas/State' - description: The current state of the function. When the state is Inactive, you can reactivate the function by invoking it. StateReason: allOf: - $ref: '#/components/schemas/StateReason' - description: The reason for the function's current state. StateReasonCode: allOf: - $ref: '#/components/schemas/StateReasonCode' - description: The reason code for the function's current state. When the code is Creating, you can't invoke or modify the function. LastUpdateStatus: allOf: - $ref: '#/components/schemas/LastUpdateStatus' - description: The status of the last update that was performed on the function. This is first set to Successful after function creation completes. LastUpdateStatusReason: allOf: - $ref: '#/components/schemas/LastUpdateStatusReason' - description: The reason for the last update that was performed on the function. LastUpdateStatusReasonCode: allOf: - $ref: '#/components/schemas/LastUpdateStatusReasonCode' - description: The reason code for the last update that was performed on the function. FileSystemConfigs: allOf: - $ref: '#/components/schemas/FileSystemConfigList' - description: Connection settings for an Amazon EFS file system. PackageType: allOf: - $ref: '#/components/schemas/PackageType' - description: The type of deployment package. Set to Image for container image and set Zip for .zip file archive. ImageConfigResponse: allOf: - $ref: '#/components/schemas/ImageConfigResponse' - description: The function's image configuration values. SigningProfileVersionArn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the signing profile version. SigningJobArn: allOf: - $ref: '#/components/schemas/Arn' - description: The ARN of the signing job. Architectures: allOf: - $ref: '#/components/schemas/ArchitecturesList' - description: The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64. EphemeralStorage: allOf: - $ref: '#/components/schemas/EphemeralStorage' - description: The size of the function's /tmp directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. SnapStart: allOf: - $ref: '#/components/schemas/SnapStartResponse' - description: Set ApplyOn to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version. For more information, see Improving startup performance with Lambda SnapStart. RuntimeVersionConfig: allOf: - $ref: '#/components/schemas/RuntimeVersionConfig' - description: The ARN of the runtime and any errors that occured. description: Details about a function's configuration. FilterCriteria: type: object properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - description: ' A list of filters. ' description: ' An object that contains the filters for an event source. ' ArchitecturesList: type: array items: $ref: '#/components/schemas/Architecture' minItems: 1 maxItems: 1 DestinationConfig: type: object properties: OnSuccess: allOf: - $ref: '#/components/schemas/OnSuccess' - description: The destination configuration for successful invocations. OnFailure: allOf: - $ref: '#/components/schemas/OnFailure' - description: The destination configuration for failed invocations. description: A configuration object that specifies the destination of an event after Lambda processes it. ImageConfigResponse: type: object properties: ImageConfig: allOf: - $ref: '#/components/schemas/ImageConfig' - description: Configuration values that override the container image Dockerfile. Error: allOf: - $ref: '#/components/schemas/ImageConfigError' - description: Error response to GetFunctionConfiguration. description: Response to a GetFunctionConfiguration request. ScalingConfig: type: object properties: MaximumConcurrency: allOf: - $ref: '#/components/schemas/MaximumConcurrency' - description: Limits the number of concurrent instances that the Amazon SQS event source can invoke. description: (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. ParallelizationFactor: type: integer minimum: 1 maximum: 10 Alias: type: string pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+) minLength: 1 maxLength: 128 LastUpdateStatusReason: type: string EFSMountTimeoutException: {} SubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' maxItems: 16 SourceAccessConfiguration: type: object properties: Type: allOf: - $ref: '#/components/schemas/SourceAccessType' - description: '

The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".

' URI: allOf: - $ref: '#/components/schemas/URI' - description: 'The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".' description: To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host. Runtime: type: string enum: - nodejs - nodejs4.3 - nodejs6.10 - nodejs8.10 - nodejs10.x - nodejs12.x - nodejs14.x - nodejs16.x - java8 - java8.al2 - java11 - python2.7 - python3.6 - python3.7 - python3.8 - python3.9 - dotnetcore1.0 - dotnetcore2.0 - dotnetcore2.1 - dotnetcore3.1 - dotnet6 - nodejs4.3-edge - go1.x - ruby2.5 - ruby2.7 - provided - provided.al2 - nodejs18.x - python3.10 FunctionList: type: array items: $ref: '#/components/schemas/FunctionConfiguration' SubnetIPAddressLimitReachedException: {} RequestTooLargeException: {} PackageType: type: string enum: - Zip - Image FileSystemConfigList: type: array items: $ref: '#/components/schemas/FileSystemConfig' maxItems: 1 SubnetId: type: string DocumentDBEventSourceConfig: type: object properties: DatabaseName: allOf: - $ref: '#/components/schemas/DatabaseName' - description: ' The name of the database to consume within the DocumentDB cluster. ' CollectionName: allOf: - $ref: '#/components/schemas/CollectionName' - description: ' The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. ' FullDocument: allOf: - $ref: '#/components/schemas/FullDocument' - description: ' Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. ' description: ' Specific configuration settings for a DocumentDB event source. ' Timeout: type: integer minimum: 1 EC2UnexpectedException: {} WorkingDirectory: type: string maxLength: 1000 FullDocument: type: string enum: - UpdateLookup - Default CodeSigningConfigNotFoundException: {} DestinationArn: type: string pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) minLength: 0 maxLength: 350 Weight: type: number format: double minimum: 0 maximum: 1 FunctionResponseType: type: string enum: - ReportBatchItemFailures KMSNotFoundException: {} LastUpdateStatusReasonCode: type: string enum: - EniLimitExceeded - InsufficientRolePermissions - InvalidConfiguration - InternalError - SubnetOutOfIPAddresses - InvalidSubnet - InvalidSecurityGroup - ImageDeleted - ImageAccessDenied - InvalidImage - KMSKeyAccessDenied - KMSKeyNotFound - InvalidStateKMSKey - DisabledKMSKey - EFSIOError - EFSMountConnectivityError - EFSMountFailure - EFSMountTimeout - InvalidRuntime - InvalidZipFileException - FunctionError AliasRoutingConfiguration: type: object properties: AdditionalVersionWeights: allOf: - $ref: '#/components/schemas/AdditionalVersionWeights' - description: The second version, and the percentage of traffic that's routed to it. description: The traffic-shifting configuration of a Lambda function alias. RuntimeVersionConfig: type: object properties: RuntimeVersionArn: allOf: - $ref: '#/components/schemas/RuntimeVersionArn' - description: The ARN of the runtime version you want the function to use. Error: allOf: - $ref: '#/components/schemas/RuntimeVersionError' - description: Error response when Lambda is unable to retrieve the runtime version for a function. description: The ARN of the runtime and any errors that occured. InvocationResponse: type: object properties: StatusCode: allOf: - $ref: '#/components/schemas/Integer' - description: The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204. Payload: allOf: - $ref: '#/components/schemas/Blob' - description: The response from the function, or an error object. PolicyLengthExceededException: {} PreconditionFailedException: {} MaximumRetryAttemptsEventSourceMapping: type: integer minimum: -1 maximum: 10000 InvalidZipFileException: {} EnvironmentResponse: type: object properties: Variables: allOf: - $ref: '#/components/schemas/EnvironmentVariables' - description: Environment variable key-value pairs. Omitted from CloudTrail logs. Error: allOf: - $ref: '#/components/schemas/EnvironmentError' - description: Error messages for environment variables that couldn't be applied. description: The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error. Long: type: integer AdditionalVersionWeights: type: object additionalProperties: $ref: '#/components/schemas/Weight' ResourceArn: type: string pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() InvalidRequestContentException: {} String: type: string S3Bucket: type: string pattern: ^[0-9A-Za-z\.\-_]*(?Managing Lambda reserved concurrency. SnapStartOptimizationStatus: type: string enum: - true - false RuntimeVersionError: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/String' - description: The error code. Message: allOf: - $ref: '#/components/schemas/SensitiveString' - description: The error message. description: Any error returned when the runtime version information for the function could not be retrieved. ImageConfig: type: object properties: EntryPoint: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies the entry point to their application, which is typically the location of the runtime executable. Command: allOf: - $ref: '#/components/schemas/StringList' - description: Specifies parameters that you want to pass in with ENTRYPOINT. WorkingDirectory: allOf: - $ref: '#/components/schemas/WorkingDirectory' - description: Specifies the working directory. description: Configuration values that override the container image Dockerfile settings. For more information, see Container image settings. ServiceException: {} TracingMode: type: string enum: - Active - PassThrough ListFunctionsResponse: type: object properties: NextMarker: allOf: - $ref: '#/components/schemas/String' - description: The pagination token that's included if more results are available. Functions: allOf: - $ref: '#/components/schemas/FunctionList' - description: A list of Lambda functions. description: A list of Lambda functions. ResourceNotFoundException: {} Architecture: type: string enum: - x86_64 - arm64 FileSystemArn: type: string pattern: arn:aws[a-zA-Z-]*:elasticfilesystem:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:access-point/fsap-[a-f0-9]{17} maxLength: 200 EC2AccessDeniedException: {} EFSMountConnectivityException: {} UnsupportedMediaTypeException: {} MemorySize: type: integer minimum: 128 maximum: 10240 FilterList: type: array items: $ref: '#/components/schemas/Filter' TagValue: type: string RoleArn: type: string pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+ SourceAccessConfigurations: type: array items: $ref: '#/components/schemas/SourceAccessConfiguration' minItems: 0 maxItems: 22 BatchSize: type: integer minimum: 1 maximum: 10000 AddPermissionResponse: type: object properties: Statement: allOf: - $ref: '#/components/schemas/String' - description: The permission statement that's added to the function policy. StateReason: type: string ResourceInUseException: {} LayerVersionArn: type: string pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+ minLength: 1 maxLength: 140 RuntimeVersionArn: type: string pattern: ^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$ minLength: 26 maxLength: 2048 EC2ThrottledException: {} Integer: type: integer SnapStartNotReadyException: {} KMSDisabledException: {} LayersReferenceList: type: array items: $ref: '#/components/schemas/Layer' OnSuccess: type: object properties: Destination: allOf: - $ref: '#/components/schemas/DestinationArn' - description: The Amazon Resource Name (ARN) of the destination resource. description: A destination for events that were processed successfully. InvalidCodeSignatureException: {} OnFailure: type: object properties: Destination: allOf: - $ref: '#/components/schemas/DestinationArn' - description: The Amazon Resource Name (ARN) of the destination resource. description: A destination for events that failed processing. InvalidSubnetIDException: {} EFSIOException: {} State: type: string enum: - Pending - Active - Inactive - Failed MaximumBatchingWindowInSeconds: type: integer minimum: 0 maximum: 300 TumblingWindowInSeconds: type: integer minimum: 0 maximum: 900 SelfManagedEventSource: type: object properties: Endpoints: allOf: - $ref: '#/components/schemas/Endpoints' - description: 'The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS": ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].' description: The self-managed Apache Kafka cluster for your event source. S3ObjectVersion: type: string minLength: 1 maxLength: 1024 LastUpdateStatus: type: string enum: - Successful - Failed - InProgress EventSourcePosition: type: string enum: - TRIM_HORIZON - LATEST - AT_TIMESTAMP Description: type: string minLength: 0 maxLength: 256 EventSourceMappingsList: type: array items: $ref: '#/components/schemas/EventSourceMappingConfiguration' ListVersionsByFunctionResponse: type: object properties: NextMarker: allOf: - $ref: '#/components/schemas/String' - description: The pagination token that's included if more results are available. Versions: allOf: - $ref: '#/components/schemas/FunctionList' - description: A list of Lambda function versions. InvalidSecurityGroupIDException: {} Queues: type: array items: $ref: '#/components/schemas/Queue' minItems: 1 maxItems: 1 Date: type: string format: date-time KMSKeyArn: type: string pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|() DeadLetterConfig: type: object properties: TargetArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. description: The dead-letter queue for failed asynchronous invocations. BisectBatchOnFunctionError: type: boolean Blob: type: string format: password NamespacedFunctionName: type: string pattern: (arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\d{1}:)?(\d{12}:)?(function:)?([a-zA-Z0-9-_\.]+)(:(\$LATEST|[a-zA-Z0-9-_]+))? minLength: 1 maxLength: 170 SnapStartException: {} Tags: type: object additionalProperties: $ref: '#/components/schemas/TagValue' Handler: type: string pattern: '[^\s]+' maxLength: 128 parameters: X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true