openapi: 3.0.0
info:
version: 2015-03-31
x-release: v4
title: APIs.io Engineering Platform AWS Lambda
description: "
Overview
Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.
The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.
You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.
For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..
When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..
CA certificates
Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:
Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.
Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.
Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.
Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.
When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:
Amazon Root CA 1
Starfield Services Root Certificate Authority - G2
Starfield Class 2 Certification Authority
Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.
" 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: lambda x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lambda-2015-03-31.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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/lambda/ servers: - url: http://lambda.{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 AWS Lambda multi-region endpoint - url: https://lambda.{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 AWS Lambda multi-region endpoint - url: http://lambda.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Lambda endpoint for China (Beijing) and China (Ningxia) - url: https://lambda.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Lambda endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy": post: operationId: AddLayerVersionPermission description:Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.
To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.
responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/AddLayerVersionPermissionResponse" "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: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "485": description: PolicyLengthExceededException content: application/json: schema: $ref: "#/components/schemas/PolicyLengthExceededException" "486": description: PreconditionFailedException content: application/json: schema: $ref: "#/components/schemas/PreconditionFailedException" parameters: - name: LayerName in: path required: true description: The name or Amazon Resource Name (ARN) of the layer. schema: type: string pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ minLength: 1 maxLength: 140 - name: VersionNumber in: path required: true description: The version number. schema: type: integer - name: RevisionId in: query required: false description: Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it. schema: type: string requestBody: required: true content: application/json: schema: type: object required: - StatementId - Action - Principal properties: StatementId: description: An identifier that distinguishes the policy from others on the same layer version. type: string pattern: ([a-zA-Z0-9-_]+) minLength: 1 maxLength: 100 Action: description: The API action that grants access to the layer. For example,lambda:GetLayerVersion.
type: string
pattern: lambda:GetLayerVersion
maxLength: 22
Principal:
description: "An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer. "
type: string
pattern: \d{12}|\*|arn:(aws[a-zA-Z-]*):iam::\d{12}:root
OrganizationId:
description: With the principal set to *, grant permission to all accounts in the specified organization.
type: string
pattern: o-[a-z0-9]{10,32}
maxLength: 34
tags:
- 2018 10 31
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: GetLayerVersionPolicy
description: Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetLayerVersionPolicyResponse"
"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: LayerName
in: path
required: true
description: The name or Amazon Resource Name (ARN) of the layer.
schema:
type: string
pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+
minLength: 1
maxLength: 140
- name: VersionNumber
in: path
required: true
description: The version number.
schema:
type: integer
tags:
- 2018 10 31
"/2015-03-31/functions/{FunctionName}/policy":
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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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.
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
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: 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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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": 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.
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 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: 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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 /2020-04-22/code-signing-configs/: post: operationId: CreateCodeSigningConfig description: 'Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). ' responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateCodeSigningConfigResponse" "480": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "481": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AllowedPublishers properties: Description: description: Descriptive name for this code signing configuration. type: string minLength: 0 maxLength: 256 AllowedPublishers: description: "List of signing profiles that can sign a code package. " type: object properties: SigningProfileVersionArns: allOf: - $ref: "#/components/schemas/SigningProfileVersionArns" - description: "The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. " CodeSigningPolicies: description: Code signing configuration policies specify the validation failure action for signature mismatch or expiry. type: object properties: UntrustedArtifactOnDeployment: allOf: - $ref: "#/components/schemas/CodeSigningPolicy" - description: "Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.
Default value: Warn
MaxItems parameter to return fewer configurations per call. '
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListCodeSigningConfigsResponse"
"480":
description: ServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceException"
"481":
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterValueException"
parameters:
- 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: Maximum number of items to return.
schema:
type: integer
minimum: 1
maximum: 10000
tags:
- 2020 04 22
/2015-03-31/event-source-mappings/:
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):
BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts – 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.
ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
The name of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
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).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
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.
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
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: 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.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
The name of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
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: 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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 toImage 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.
PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.
tags:
- 2015 03 31
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"
"/2021-10-31/functions/{FunctionName}/url":
post:
operationId: CreateFunctionUrlConfig
description: Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
responses:
"201":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateFunctionUrlConfigResponse"
"480":
description: ResourceConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceConflictException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterValueException"
"483":
description: ServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceException"
"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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: The alias name. schema: type: string pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+)) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - AuthType properties: AuthType: description: The type of authentication that your function URL uses. Set toAWS_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
Cors:
description: The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
type: object
properties:
AllowCredentials:
allOf:
- $ref: "#/components/schemas/AllowCredentials"
- description: Whether to allow cookies or other credentials in requests to your function URL. The default is false.
AllowHeaders:
allOf:
- $ref: "#/components/schemas/HeadersList"
- description: "The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header."
AllowMethods:
allOf:
- $ref: "#/components/schemas/AllowMethodsList"
- description: "The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*)."
AllowOrigins:
allOf:
- $ref: "#/components/schemas/AllowOriginsList"
- description: "The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.
Alternatively, you can grant access to all origins using the wildcard character (*).
Date, Keep-Alive, X-Custom-Header."
MaxAge:
allOf:
- $ref: "#/components/schemas/MaxAge"
- description: The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.
InvokeMode:
description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: The alias name. schema: type: string pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+)) minLength: 1 maxLength: 128 tags: - 2021 10 31 get: operationId: GetFunctionUrlConfig description: Returns details about a Lambda function URL. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetFunctionUrlConfigResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: The alias name. schema: type: string pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+)) minLength: 1 maxLength: 128 tags: - 2021 10 31 put: operationId: UpdateFunctionUrlConfig description: Updates the configuration for a Lambda function URL. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateFunctionUrlConfigResponse" "480": description: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "483": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: The alias name. schema: type: string pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+)) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: AuthType: description: The type of authentication that your function URL uses. Set toAWS_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
Cors:
description: The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
type: object
properties:
AllowCredentials:
allOf:
- $ref: "#/components/schemas/AllowCredentials"
- description: Whether to allow cookies or other credentials in requests to your function URL. The default is false.
AllowHeaders:
allOf:
- $ref: "#/components/schemas/HeadersList"
- description: "The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header."
AllowMethods:
allOf:
- $ref: "#/components/schemas/AllowMethodsList"
- description: "The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*)."
AllowOrigins:
allOf:
- $ref: "#/components/schemas/AllowOriginsList"
- description: "The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.
Alternatively, you can grant access to all origins using the wildcard character (*).
Date, Keep-Alive, X-Custom-Header."
MaxAge:
allOf:
- $ref: "#/components/schemas/MaxAge"
- description: The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.
InvokeMode:
description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 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: 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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 "/2020-04-22/code-signing-configs/{CodeSigningConfigArn}": delete: operationId: DeleteCodeSigningConfig description: "Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it. " responses: "204": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteCodeSigningConfigResponse" "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" parameters: - name: CodeSigningConfigArn in: path required: true description: The The Amazon Resource Name (ARN) of the code signing configuration. schema: 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 tags: - 2020 04 22 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: GetCodeSigningConfig description: Returns information about the specified code signing configuration. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetCodeSigningConfigResponse" "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" parameters: - name: CodeSigningConfigArn in: path required: true description: "The The Amazon Resource Name (ARN) of the code signing configuration. " schema: 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 tags: - 2020 04 22 put: operationId: UpdateCodeSigningConfig description: "Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateCodeSigningConfigResponse" "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" parameters: - name: CodeSigningConfigArn in: path required: true description: The The Amazon Resource Name (ARN) of the code signing configuration. schema: 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 requestBody: required: true content: application/json: schema: type: object properties: Description: description: Descriptive name for this code signing configuration. type: string minLength: 0 maxLength: 256 AllowedPublishers: description: "List of signing profiles that can sign a code package. " type: object properties: SigningProfileVersionArns: allOf: - $ref: "#/components/schemas/SigningProfileVersionArns" - description: "The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. " CodeSigningPolicies: description: Code signing configuration policies specify the validation failure action for signature mismatch or expiry. type: object properties: UntrustedArtifactOnDeployment: allOf: - $ref: "#/components/schemas/CodeSigningPolicy" - description: "Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.
Default value: Warn
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.
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):
BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.
DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.
MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires
MaximumRetryAttempts – 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.
ParallelizationFactor – Process multiple batches from each shard concurrently.
For information about which configuration parameters apply to each event source, see the following topics.
The name of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
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).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
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.
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
Function name – my-function (name-only), my-function:1 (with version).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 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: 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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 "/2020-06-30/functions/{FunctionName}/code-signing-config": delete: operationId: DeleteFunctionCodeSigningConfig description: Removes the code signing configuration from the function. responses: "204": description: Success "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: "#/components/schemas/CodeSigningConfigNotFoundException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 tags: - 2020 06 30 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: GetFunctionCodeSigningConfig description: Returns the code signing configuration for the specified function. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetFunctionCodeSigningConfigResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 tags: - 2020 06 30 put: operationId: PutFunctionCodeSigningConfig description: "Update the code signing configuration for the function. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutFunctionCodeSigningConfigResponse" "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: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" "485": 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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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: - CodeSigningConfigArn properties: CodeSigningConfigArn: description: The The Amazon Resource Name (ARN) of the code signing configuration. 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 tags: - 2020 06 30 "/2017-10-31/functions/{FunctionName}/concurrency": delete: operationId: DeleteFunctionConcurrency description: Removes a concurrent execution limit from a function. 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.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 tags: - 2017 10 31 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: PutFunctionConcurrency description:Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.
Use GetAccountSettings to see your Regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Lambda function scaling.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/Concurrency" "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: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "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.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: - ReservedConcurrentExecutions properties: ReservedConcurrentExecutions: description: The number of simultaneous executions to reserve for the function. type: integer minimum: 0 tags: - 2017 10 31 "/2019-09-25/functions/{FunctionName}/event-invoke-config": delete: operationId: DeleteFunctionEventInvokeConfig description:Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
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: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: A version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2019 09 25 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: GetFunctionEventInvokeConfig description:Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/FunctionEventInvokeConfig" "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, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: A version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2019 09 25 put: operationId: PutFunctionEventInvokeConfig description:Configures options for asynchronous invocation on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use UpdateFunctionEventInvokeConfig.
By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with UpdateFunctionConfiguration.
To send an invocation record to a queue, topic, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/FunctionEventInvokeConfig" "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" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: A version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: MaximumRetryAttempts: description: The maximum number of times to retry when the function returns an error. type: integer minimum: 0 maximum: 2 MaximumEventAgeInSeconds: description: The maximum age of a request that Lambda sends to a function for processing. type: integer minimum: 60 maximum: 21600 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. tags: - 2019 09 25 post: operationId: UpdateFunctionEventInvokeConfig description:Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/FunctionEventInvokeConfig" "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" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function, version, or alias.
Name formats
Function name - my-function (name-only), my-function:v1 (with alias).
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: A version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: MaximumRetryAttempts: description: The maximum number of times to retry when the function returns an error. type: integer minimum: 0 maximum: 2 MaximumEventAgeInSeconds: description: The maximum age of a request that Lambda sends to a function for processing. type: integer minimum: 60 maximum: 21600 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. tags: - 2019 09 25 "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}": delete: operationId: DeleteLayerVersion description: Deletes a version of an Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it. responses: "204": description: Success "480": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "481": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: - name: LayerName in: path required: true description: The name or Amazon Resource Name (ARN) of the layer. schema: type: string pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ minLength: 1 maxLength: 140 - name: VersionNumber in: path required: true description: The version number. schema: type: integer tags: - 2018 10 31 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: GetLayerVersion description: Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetLayerVersionResponse" "480": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "481": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: LayerName in: path required: true description: The name or Amazon Resource Name (ARN) of the layer. schema: type: string pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ minLength: 1 maxLength: 140 - name: VersionNumber in: path required: true description: The version number. schema: type: integer tags: - 2018 10 31 "/2019-09-30/functions/{FunctionName}/provisioned-concurrency#Qualifier": delete: operationId: DeleteProvisionedConcurrencyConfig description: Deletes the provisioned concurrency configuration for a function. responses: "204": description: Success "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: true description: The version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2019 09 30 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: GetProvisionedConcurrencyConfig description: Retrieves the provisioned concurrency configuration for a function's alias or version. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetProvisionedConcurrencyConfigResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "483": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "484": description: ProvisionedConcurrencyConfigNotFoundException content: application/json: schema: $ref: "#/components/schemas/ProvisionedConcurrencyConfigNotFoundException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: true description: The version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 tags: - 2019 09 30 put: operationId: PutProvisionedConcurrencyConfig description: Adds a provisioned concurrency configuration to a function's alias or version. responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/PutProvisionedConcurrencyConfigResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: true description: The version number or alias name. schema: type: string pattern: (|[a-zA-Z0-9$_-]+) minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - ProvisionedConcurrentExecutions properties: ProvisionedConcurrentExecutions: description: The amount of provisioned concurrency to allocate for the version or alias. type: integer minimum: 1 tags: - 2019 09 30 /2016-08-19/account-settings/: get: operationId: GetAccountSettings description: Retrieves details about your account's limits and usage in an Amazon Web Services Region. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetAccountSettingsResponse" "480": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "481": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" parameters: [] tags: - 2016 08 19 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" "/2019-09-30/functions/{FunctionName}/concurrency": get: operationId: GetFunctionConcurrency description: Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetFunctionConcurrencyResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "483": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 tags: - 2019 09 30 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" "/2015-03-31/functions/{FunctionName}/configuration": 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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 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: 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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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, setMode 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.
PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.
tags:
- 2015 03 31
/2018-10-31/layers#find=LayerVersion&Arn:
get:
operationId: GetLayerVersionByArn
description: Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetLayerVersionResponse"
"480":
description: ServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceException"
"481":
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterValueException"
"482":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
parameters:
- name: Arn
in: query
required: true
description: The ARN of the layer version.
schema:
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
- name: find
in: query
required: true
schema:
type: string
enum:
- LayerVersion
tags:
- 2018 10 31
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"
"/2021-07-20/functions/{FunctionName}/runtime-management-config":
get:
operationId: GetRuntimeManagementConfig
description: Retrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetRuntimeManagementConfigResponse"
"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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 of the function. This can be$LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.
schema:
type: string
pattern: (|[a-zA-Z0-9$_-]+)
minLength: 1
maxLength: 128
tags:
- 2021 07 20
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: PutRuntimeManagementConfig
description: Sets the runtime management configuration for a function's version. For more information, see Runtime updates.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/PutRuntimeManagementConfigResponse"
"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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 of the function. This can be$LATEST or a published version number. If no value is specified, the configuration for the $LATEST version is returned.
schema:
type: string
pattern: (|[a-zA-Z0-9$_-]+)
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- UpdateRuntimeOn
properties:
UpdateRuntimeOn:
description: Specify the runtime update mode.
Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.
The ARN of the runtime version you want the function to use.
This is only required if you're using the Manual runtime update mode.
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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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.
RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
Event – Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if one is configured). The API response only includes a status code.
DryRun – Validate parameter values and verify that the user or role has permission to invoke the function.
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.
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously.
responses: "202": description: Success content: application/json: schema: $ref: "#/components/schemas/InvokeAsyncResponse" "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: InvalidRuntimeException content: application/json: schema: $ref: "#/components/schemas/InvalidRuntimeException" "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.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 requestBody: required: true content: application/json: schema: type: object required: - InvokeArgs properties: InvokeArgs: description: The JSON that you want to provide to your Lambda function as input. type: string tags: - 2014 11 13 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" "/2021-11-15/functions/{FunctionName}/response-streaming-invocations": post: operationId: InvokeWithResponseStream description:Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses.
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/InvokeWithResponseStreamResponse" "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.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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:Use one of the following options:
RequestResponse (default) – Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API operation response includes the function response and additional data.
DryRun – Validate parameter values and verify that the IAM user or role has permission to invoke the function.
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: The alias name.
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.
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListFunctionEventInvokeConfigsResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "483": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
Function name - my-function.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: 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 configurations to return. schema: type: integer minimum: 1 maximum: 50 tags: - 2019 09 25 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" "/2021-10-31/functions/{FunctionName}/urls": get: operationId: ListFunctionUrlConfigs description: Returns a list of Lambda function URLs for the specified function. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListFunctionUrlConfigsResponse" "480": description: InvalidParameterValueException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterValueException" "481": description: ServiceException content: application/json: schema: $ref: "#/components/schemas/ServiceException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "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
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: 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 function URLs to return in the response. Note thatListFunctionUrlConfigs returns a maximum of 50 items in each response, even if you set the number higher.
schema:
type: integer
minimum: 1
maximum: 50
tags:
- 2021 10 31
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"
/2015-03-31/functions/:
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.
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
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"
"/2020-04-22/code-signing-configs/{CodeSigningConfigArn}/functions":
get:
operationId: ListFunctionsByCodeSigningConfig
description: List the functions that use the specified code signing configuration. You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListFunctionsByCodeSigningConfigResponse"
"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"
parameters:
- name: CodeSigningConfigArn
in: path
required: true
description: The The Amazon Resource Name (ARN) of the code signing configuration.
schema:
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
- 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: Maximum number of items to return.
schema:
type: integer
minimum: 1
maximum: 10000
tags:
- 2020 04 22
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"
"/2018-10-31/layers/{LayerName}/versions":
get:
operationId: ListLayerVersions
description: Lists the versions of an Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime. Specify a compatible architecture to include only layer versions that are compatible with that architecture.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListLayerVersionsResponse"
"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: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
parameters:
- name: CompatibleRuntime
in: query
required: false
description: A runtime identifier. For example, go1.x.
schema:
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
- name: LayerName
in: path
required: true
description: The name or Amazon Resource Name (ARN) of the layer.
schema:
type: string
pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[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 versions to return.
schema:
type: integer
minimum: 1
maximum: 50
- name: CompatibleArchitecture
in: query
required: false
description: The compatible instruction set architecture.
schema:
type: string
enum:
- x86_64
- arm64
tags:
- 2018 10 31
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: PublishLayerVersion
description: Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.
Add layers to your function with CreateFunction or UpdateFunctionConfiguration.
responses: "201": description: Success content: application/json: schema: $ref: "#/components/schemas/PublishLayerVersionResponse" "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: CodeStorageExceededException content: application/json: schema: $ref: "#/components/schemas/CodeStorageExceededException" parameters: - name: LayerName in: path required: true description: The name or Amazon Resource Name (ARN) of the layer. schema: type: string pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ minLength: 1 maxLength: 140 requestBody: required: true content: application/json: schema: type: object required: - Content properties: Description: description: The description of the version. type: string minLength: 0 maxLength: 256 Content: description: A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly. type: object properties: S3Bucket: allOf: - $ref: "#/components/schemas/S3Bucket" - description: The Amazon S3 bucket of the layer archive. S3Key: allOf: - $ref: "#/components/schemas/S3Key" - description: The Amazon S3 key of the layer archive. S3ObjectVersion: allOf: - $ref: "#/components/schemas/S3ObjectVersion" - description: For versioned objects, the version of the layer archive object to use. ZipFile: allOf: - $ref: "#/components/schemas/Blob" - description: The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you. CompatibleRuntimes: description: A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions. type: array items: $ref: "#/components/schemas/Runtime" maxItems: 15 LicenseInfo: description:The layer's software license. It can be any of the following:
An SPDX license identifier. For example, MIT.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.
The full text of the license.
go1.x.
schema:
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
- 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 layers to return.
schema:
type: integer
minimum: 1
maximum: 50
- name: CompatibleArchitecture
in: query
required: false
description: The compatible instruction set architecture.
schema:
type: string
enum:
- x86_64
- arm64
tags:
- 2018 10 31
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"
"/2019-09-30/functions/{FunctionName}/provisioned-concurrency#List=ALL":
get:
operationId: ListProvisionedConcurrencyConfigs
description: Retrieves a list of provisioned concurrency configurations for a function.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListProvisionedConcurrencyConfigsResponse"
"480":
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterValueException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: TooManyRequestsException
content:
application/json:
schema:
$ref: "#/components/schemas/TooManyRequestsException"
"483":
description: ServiceException
content:
application/json:
schema:
$ref: "#/components/schemas/ServiceException"
parameters:
- name: FunctionName
in: path
required: true
description: The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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: 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: Specify a number to limit the number of configurations returned. schema: type: integer minimum: 1 maximum: 50 - name: List in: query required: true schema: type: string enum: - ALL tags: - 2019 09 30 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" "/2017-03-31/tags/{ARN}": get: operationId: ListTags description: Returns a function's tags. You can also view tags with GetFunction. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsResponse" "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: ARN in: path required: true description: "The function's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to aliases or versions." 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-_]+))? tags: - 2017 03 31 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: TagResource description: Adds tags to a function. 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: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" parameters: - name: ARN in: path required: true description: The function's Amazon Resource Name (ARN). 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-_]+))? requestBody: required: true content: application/json: schema: type: object required: - Tags properties: Tags: description: A list of tags to apply to the function. type: object additionalProperties: $ref: "#/components/schemas/TagValue" tags: - 2017 03 31 "/2015-03-31/functions/{FunctionName}/versions": 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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 thatListVersionsByFunction 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
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: 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
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
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 "/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}": delete: operationId: RemoveLayerVersionPermission description: Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. 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: LayerName in: path required: true description: The name or Amazon Resource Name (ARN) of the layer. schema: type: string pattern: (arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+ minLength: 1 maxLength: 140 - name: VersionNumber in: path required: true description: The version number. schema: type: integer - name: StatementId in: path required: true description: The identifier that was specified when the statement was added. schema: type: string pattern: ([a-zA-Z0-9-_]+) minLength: 1 maxLength: 100 - name: RevisionId in: query required: false description: Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it. schema: type: string tags: - 2018 10 31 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" "/2015-03-31/functions/{FunctionName}/policy/{StatementId}": 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
Function name – my-function (name-only), my-function:v1 (with alias).
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 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" "/2017-03-31/tags/{ARN}#tagKeys": delete: operationId: UntagResource description: Removes tags from a function. 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: ResourceConflictException content: application/json: schema: $ref: "#/components/schemas/ResourceConflictException" parameters: - name: ARN in: path required: true description: The function's Amazon Resource Name (ARN). 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-_]+))? - name: tagKeys in: query required: true description: A list of tag keys to remove from the function. schema: type: array items: $ref: "#/components/schemas/TagKey" tags: - 2017 03 31 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" "/2015-03-31/functions/{FunctionName}/code": 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.
The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 isx86_64.
type: array
items:
$ref: "#/components/schemas/Architecture"
minItems: 1
maxItems: 1
tags:
- 2015 03 31
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"
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
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
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
schemas:
AddLayerVersionPermissionResponse:
type: object
properties:
Statement:
allOf:
- $ref: "#/components/schemas/String"
- description: The permission statement.
RevisionId:
allOf:
- $ref: "#/components/schemas/String"
- description: A unique identifier for the current revision of the policy.
ServiceException: {}
ResourceNotFoundException: {}
ResourceConflictException: {}
TooManyRequestsException: {}
InvalidParameterValueException: {}
PolicyLengthExceededException: {}
PreconditionFailedException: {}
AddPermissionResponse:
type: object
properties:
Statement:
allOf:
- $ref: "#/components/schemas/String"
- description: The permission statement that's added to the function policy.
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.
AdditionalVersionWeights:
type: object
additionalProperties:
$ref: "#/components/schemas/Weight"
CreateCodeSigningConfigResponse:
type: object
required:
- CodeSigningConfig
properties:
CodeSigningConfig:
allOf:
- $ref: "#/components/schemas/CodeSigningConfig"
- description: The code signing configuration.
SigningProfileVersionArns:
type: array
items:
$ref: "#/components/schemas/Arn"
minItems: 1
maxItems: 20
CodeSigningPolicy:
type: string
enum:
- Warn
- Enforce
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.
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.
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.
The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".
BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.
CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
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.
Endpoints:
type: object
minProperties: 1
maxProperties: 2
additionalProperties:
$ref: "#/components/schemas/EndpointLists"
FunctionResponseType:
type: string
enum:
- ReportBatchItemFailures
URI:
type: string
pattern: "[a-zA-Z0-9-\\/*:_+=.@-]*"
minLength: 1
maxLength: 200
MaximumConcurrency:
type: integer
minimum: 2
maximum: 1000
DatabaseName:
type: string
pattern: "[^ /\\.$\\x22]*"
minLength: 1
maxLength: 63
CollectionName:
type: string
pattern: (^(?!(system\x2e)))(^[_a-zA-Z0-9])([^$]*)
minLength: 1
maxLength: 57
FullDocument:
type: string
enum:
- UpdateLookup
- Default
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 isInactive, 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.
Blob:
type: string
format: password
S3Bucket:
type: string
pattern: ^[0-9A-Za-z\.\-_]*(?/mnt/.
description: Details about the connection between a Lambda function and an Amazon EFS file system.
StringList:
type: array
items:
$ref: "#/components/schemas/String"
maxItems: 1500
WorkingDirectory:
type: string
maxLength: 1000
Architecture:
type: string
enum:
- x86_64
- arm64
EphemeralStorageSize:
type: integer
minimum: 512
maximum: 10240
SnapStartApplyOn:
type: string
enum:
- PublishedVersions
- None
CodeStorageExceededException: {}
CodeVerificationFailedException: {}
InvalidCodeSignatureException: {}
CodeSigningConfigNotFoundException: {}
CreateFunctionUrlConfigResponse:
type: object
required:
- FunctionUrl
- FunctionArn
- AuthType
- CreationTime
properties:
FunctionUrl:
allOf:
- $ref: "#/components/schemas/FunctionUrl"
- description: The HTTP URL endpoint for your function.
FunctionArn:
allOf:
- $ref: "#/components/schemas/FunctionArn"
- description: The Amazon Resource Name (ARN) of your function.
AuthType:
allOf:
- $ref: "#/components/schemas/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.
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
CreationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
GetFunctionConcurrencyResponse: type: object properties: ReservedConcurrentExecutions: allOf: - $ref: "#/components/schemas/ReservedConcurrentExecutions" - description: The number of simultaneous executions that are reserved for the function. FunctionEventInvokeConfig: type: object properties: LastModified: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the configuration was last updated. FunctionArn: allOf: - $ref: "#/components/schemas/FunctionArn" - description: The Amazon Resource Name (ARN) of the function. MaximumRetryAttempts: allOf: - $ref: "#/components/schemas/MaximumRetryAttempts" - description: The maximum number of times to retry when the function returns an error. MaximumEventAgeInSeconds: allOf: - $ref: "#/components/schemas/MaximumEventAgeInSeconds" - description: The maximum age of a request that Lambda sends to a function for processing. DestinationConfig: allOf: - $ref: "#/components/schemas/DestinationConfig" - description:A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
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.
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
CreationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
null is returned.
FunctionArn:
allOf:
- $ref: "#/components/schemas/NameSpacedFunctionArn"
- description: The Amazon Resource Name (ARN) of your function.
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.
InvalidRequestContentException: {}
RequestTooLargeException: {}
UnsupportedMediaTypeException: {}
EC2UnexpectedException: {}
SubnetIPAddressLimitReachedException: {}
ENILimitReachedException: {}
EFSMountConnectivityException: {}
EFSMountFailureException: {}
EFSMountTimeoutException: {}
EFSIOException: {}
SnapStartException: {}
SnapStartTimeoutException: {}
SnapStartNotReadyException: {}
EC2ThrottledException: {}
EC2AccessDeniedException: {}
InvalidSubnetIDException: {}
InvalidSecurityGroupIDException: {}
InvalidZipFileException: {}
KMSDisabledException: {}
KMSInvalidStateException: {}
KMSAccessDeniedException: {}
KMSNotFoundException: {}
InvalidRuntimeException: {}
ResourceNotReadyException: {}
InvokeAsyncResponse:
type: object
deprecated: true
properties:
Status:
allOf:
- $ref: "#/components/schemas/HttpStatus"
- description: The status code.
description: A success response (202 Accepted) indicates that the request is queued for invocation.
InvokeWithResponseStreamResponse:
type: object
properties:
StatusCode:
allOf:
- $ref: "#/components/schemas/Integer"
- description: For a successful request, the HTTP status code is in the 200 range. For the RequestResponse invocation type, this status code is 200. For the DryRun invocation type, this status code is 204.
EventStream:
allOf:
- $ref: "#/components/schemas/InvokeWithResponseStreamResponseEvent"
- description: The stream of response payloads.
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.
ListCodeSigningConfigsResponse:
type: object
properties:
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token that's included if more results are available.
CodeSigningConfigs:
allOf:
- $ref: "#/components/schemas/CodeSigningConfigList"
- description: The code signing configurations
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.
ListFunctionEventInvokeConfigsResponse:
type: object
properties:
FunctionEventInvokeConfigs:
allOf:
- $ref: "#/components/schemas/FunctionEventInvokeConfigList"
- description: A list of configurations.
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token that's included if more results are available.
ListFunctionUrlConfigsResponse:
type: object
required:
- FunctionUrlConfigs
properties:
FunctionUrlConfigs:
allOf:
- $ref: "#/components/schemas/FunctionUrlConfigList"
- description: A list of function URL configurations.
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token that's included if more results are available.
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.
ListFunctionsByCodeSigningConfigResponse:
type: object
properties:
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token that's included if more results are available.
FunctionArns:
allOf:
- $ref: "#/components/schemas/FunctionArnList"
- description: "The function ARNs. "
ListLayerVersionsResponse:
type: object
properties:
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token returned when the response doesn't contain all versions.
LayerVersions:
allOf:
- $ref: "#/components/schemas/LayerVersionsList"
- description: A list of versions.
ListLayersResponse:
type: object
properties:
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: A pagination token returned when the response doesn't contain all layers.
Layers:
allOf:
- $ref: "#/components/schemas/LayersList"
- description: A list of function layers.
ListProvisionedConcurrencyConfigsResponse:
type: object
properties:
ProvisionedConcurrencyConfigs:
allOf:
- $ref: "#/components/schemas/ProvisionedConcurrencyConfigList"
- description: A list of provisioned concurrency configurations.
NextMarker:
allOf:
- $ref: "#/components/schemas/String"
- description: The pagination token that's included if more results are available.
ListTagsResponse:
type: object
properties:
Tags:
allOf:
- $ref: "#/components/schemas/Tags"
- description: The function's tags.
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.
PublishLayerVersionResponse:
type: object
properties:
Content:
allOf:
- $ref: "#/components/schemas/LayerVersionContentOutput"
- description: Details about the layer version.
LayerArn:
allOf:
- $ref: "#/components/schemas/LayerArn"
- description: The ARN of the layer.
LayerVersionArn:
allOf:
- $ref: "#/components/schemas/LayerVersionArn"
- description: The ARN of the layer version.
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: The description of the version.
CreatedDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Version:
allOf:
- $ref: "#/components/schemas/LayerVersionNumber"
- description: The version number.
CompatibleRuntimes:
allOf:
- $ref: "#/components/schemas/CompatibleRuntimes"
- description: The layer's compatible runtimes.
LicenseInfo:
allOf:
- $ref: "#/components/schemas/LicenseInfo"
- description: The layer's software license.
CompatibleArchitectures:
allOf:
- $ref: "#/components/schemas/CompatibleArchitectures"
- description: A list of compatible instruction set architectures.
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
PutFunctionCodeSigningConfigResponse:
type: object
required:
- CodeSigningConfigArn
- FunctionName
properties:
CodeSigningConfigArn:
allOf:
- $ref: "#/components/schemas/CodeSigningConfigArn"
- description: The The Amazon Resource Name (ARN) of the code signing configuration.
FunctionName:
allOf:
- $ref: "#/components/schemas/FunctionName"
- description: The name of the Lambda function.
Name formats
Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
Concurrency: type: object properties: ReservedConcurrentExecutions: allOf: - $ref: "#/components/schemas/ReservedConcurrentExecutions" - description: The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved concurrency. PutProvisionedConcurrencyConfigResponse: type: object properties: RequestedProvisionedConcurrentExecutions: allOf: - $ref: "#/components/schemas/PositiveInteger" - description: The amount of provisioned concurrency requested. AvailableProvisionedConcurrentExecutions: allOf: - $ref: "#/components/schemas/NonNegativeInteger" - description: The amount of provisioned concurrency available. AllocatedProvisionedConcurrentExecutions: allOf: - $ref: "#/components/schemas/NonNegativeInteger" - description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions. Status: allOf: - $ref: "#/components/schemas/ProvisionedConcurrencyStatusEnum" - description: The status of the allocation process. StatusReason: allOf: - $ref: "#/components/schemas/String" - description: For failed allocations, the reason that provisioned concurrency could not be allocated. LastModified: allOf: - $ref: "#/components/schemas/Timestamp" - description: The date and time that a user last updated the configuration, in ISO 8601 format. PutRuntimeManagementConfigResponse: type: object required: - UpdateRuntimeOn - FunctionArn properties: UpdateRuntimeOn: allOf: - $ref: "#/components/schemas/UpdateRuntimeOn" - description: The runtime update mode. FunctionArn: allOf: - $ref: "#/components/schemas/FunctionArn" - description: The ARN of the function RuntimeVersionArn: allOf: - $ref: "#/components/schemas/RuntimeVersionArn" - description: The ARN of the runtime the function is configured to use. If the runtime update mode is manual, the ARN is returned, otherwisenull is returned.
TagKey:
type: string
UpdateCodeSigningConfigResponse:
type: object
required:
- CodeSigningConfig
properties:
CodeSigningConfig:
allOf:
- $ref: "#/components/schemas/CodeSigningConfig"
- description: The code signing configuration
UpdateFunctionUrlConfigResponse:
type: object
required:
- FunctionUrl
- FunctionArn
- AuthType
- CreationTime
- LastModifiedTime
properties:
FunctionUrl:
allOf:
- $ref: "#/components/schemas/FunctionUrl"
- description: The HTTP URL endpoint for your function.
FunctionArn:
allOf:
- $ref: "#/components/schemas/FunctionArn"
- description: The Amazon Resource Name (ARN) of your function.
AuthType:
allOf:
- $ref: "#/components/schemas/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.
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
CreationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
lambda:GetLayerVersion.
Principal:
allOf:
- $ref: "#/components/schemas/LayerPermissionAllowedPrincipal"
- description: "An account ID, or * to grant layer usage permission to all accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified). For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer. "
OrganizationId:
allOf:
- $ref: "#/components/schemas/OrganizationId"
- description: With the principal set to *, grant permission to all accounts in the specified organization.
FunctionName:
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
Principal:
type: string
pattern: "[^\\s]+"
Arn:
type: string
pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
SourceOwner:
type: string
pattern: \d{12}
maxLength: 12
EventSourceToken:
type: string
pattern: "[a-zA-Z0-9._\\-]+"
minLength: 0
maxLength: 256
Qualifier:
type: string
pattern: (|[a-zA-Z0-9$_-]+)
minLength: 1
maxLength: 128
PrincipalOrgID:
type: string
pattern: ^o-[a-z0-9]{10,32}$
minLength: 12
maxLength: 34
FunctionUrlAuthType:
type: string
enum:
- NONE
- AWS_IAM
AddPermissionRequest:
type: object
required:
- StatementId
- Action
- Principal
title: AddPermissionRequest
properties:
StatementId:
allOf:
- $ref: "#/components/schemas/StatementId"
- description: A statement identifier that differentiates the statement from others in the same policy.
Action:
allOf:
- $ref: "#/components/schemas/Action"
- description: The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.
Principal:
allOf:
- $ref: "#/components/schemas/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.
SourceArn:
allOf:
- $ref: "#/components/schemas/Arn"
- 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.
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.
EventSourceToken:
allOf:
- $ref: "#/components/schemas/EventSourceToken"
- description: For Alexa Smart Home functions, a token that the invoker must supply.
RevisionId:
allOf:
- $ref: "#/components/schemas/String"
- 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.
PrincipalOrgID:
allOf:
- $ref: "#/components/schemas/PrincipalOrgID"
- description: The identifier for your organization in Organizations. Use this to grant permissions to all the Amazon Web Services accounts under this organization.
FunctionUrlAuthType:
allOf:
- $ref: "#/components/schemas/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.
AdditionalVersion:
type: string
pattern: "[0-9]+"
minLength: 1
maxLength: 1024
Weight:
type: number
format: double
minimum: 0
maximum: 1
Alias:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
minLength: 1
maxLength: 128
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-_]+))?
Version:
type: string
pattern: (\$LATEST|[0-9]+)
minLength: 1
maxLength: 1024
Description:
type: string
minLength: 0
maxLength: 256
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.
AliasList:
type: array
items:
$ref: "#/components/schemas/AliasConfiguration"
Method:
type: string
pattern: .*
maxLength: 6
Origin:
type: string
pattern: .*
minLength: 1
maxLength: 253
AllowedPublishers:
type: object
required:
- SigningProfileVersionArns
properties:
SigningProfileVersionArns:
allOf:
- $ref: "#/components/schemas/SigningProfileVersionArns"
- description: "The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. "
description: "List of signing profiles that can sign a code package. "
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.
ArchitecturesList:
type: array
items:
$ref: "#/components/schemas/Architecture"
minItems: 1
maxItems: 1
BatchSize:
type: integer
minimum: 1
maximum: 10000
BisectBatchOnFunctionError:
type: boolean
BlobStream:
type: string
Boolean:
type: boolean
CodeSigningConfigId:
type: string
pattern: csc-[a-zA-Z0-9-_\.]{17}
CodeSigningConfigArn:
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
CodeSigningPolicies:
type: object
properties:
UntrustedArtifactOnDeployment:
allOf:
- $ref: "#/components/schemas/CodeSigningPolicy"
- description: "Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log.
Default value: Warn
false.
AllowHeaders:
allOf:
- $ref: "#/components/schemas/HeadersList"
- description: "The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive, X-Custom-Header."
AllowMethods:
allOf:
- $ref: "#/components/schemas/AllowMethodsList"
- description: "The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE, or the wildcard character (*)."
AllowOrigins:
allOf:
- $ref: "#/components/schemas/AllowOriginsList"
- description: "The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: https://www.example.com, http://localhost:60905.
Alternatively, you can grant access to all origins using the wildcard character (*).
Date, Keep-Alive, X-Custom-Header."
MaxAge:
allOf:
- $ref: "#/components/schemas/MaxAge"
- description: The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to 0, which means that the browser doesn't cache results.
description: The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.
CreateAliasRequest:
type: object
required:
- Name
- FunctionVersion
title: CreateAliasRequest
properties:
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.
CreateCodeSigningConfigRequest:
type: object
required:
- AllowedPublishers
title: CreateCodeSigningConfigRequest
properties:
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: Descriptive name for this code signing configuration.
AllowedPublishers:
allOf:
- $ref: "#/components/schemas/AllowedPublishers"
- description: Signing profiles for this code signing configuration.
CodeSigningPolicies:
allOf:
- $ref: "#/components/schemas/CodeSigningPolicies"
- description: "The code signing policies define the actions to take if the validation checks fail. "
Enabled:
type: boolean
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. "
MaximumBatchingWindowInSeconds:
type: integer
minimum: 0
maximum: 300
ParallelizationFactor:
type: integer
minimum: 1
maximum: 10
EventSourcePosition:
type: string
enum:
- TRIM_HORIZON
- LATEST
- AT_TIMESTAMP
Date:
type: string
format: date-time
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.
MaximumRecordAgeInSeconds:
type: integer
minimum: -1
maximum: 604800
MaximumRetryAttemptsEventSourceMapping:
type: integer
minimum: -1
maximum: 10000
TumblingWindowInSeconds:
type: integer
minimum: 0
maximum: 900
Topics:
type: array
items:
$ref: "#/components/schemas/Topic"
minItems: 1
maxItems: 1
Queues:
type: array
items:
$ref: "#/components/schemas/Queue"
minItems: 1
maxItems: 1
SourceAccessConfigurations:
type: array
items:
$ref: "#/components/schemas/SourceAccessConfiguration"
minItems: 0
maxItems: 22
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.
FunctionResponseTypeList:
type: array
items:
$ref: "#/components/schemas/FunctionResponseType"
minItems: 0
maxItems: 1
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.
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.
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. "
CreateEventSourceMappingRequest:
type: object
required:
- FunctionName
title: CreateEventSourceMappingRequest
properties:
EventSourceArn:
allOf:
- $ref: "#/components/schemas/Arn"
- description: The Amazon Resource Name (ARN) of the event source.
Amazon Kinesis – The ARN of the data stream or a stream consumer.
Amazon DynamoDB Streams – The ARN of the stream.
Amazon Simple Queue Service – The ARN of the queue.
Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
Amazon MQ – The ARN of the broker.
Amazon DocumentDB – The ARN of the DocumentDB change stream.
The name of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Enabled: allOf: - $ref: "#/components/schemas/Enabled" - description: "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
" 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).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
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.
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.
DestinationConfig:
allOf:
- $ref: "#/components/schemas/DestinationConfig"
- description: (Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.
MaximumRecordAgeInSeconds:
allOf:
- $ref: "#/components/schemas/MaximumRecordAgeInSeconds"
- description: (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
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.
MaximumRetryAttempts:
allOf:
- $ref: "#/components/schemas/MaximumRetryAttemptsEventSourceMapping"
- 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.
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.
Topics:
allOf:
- $ref: "#/components/schemas/Topics"
- description: The name of the Kafka topic.
Queues:
allOf:
- $ref: "#/components/schemas/Queues"
- description: " (MQ) The name of the Amazon MQ broker destination queue to consume. "
SourceAccessConfigurations:
allOf:
- $ref: "#/components/schemas/SourceAccessConfigurations"
- description: An array of authentication protocols or VPC components required to secure your event source.
SelfManagedEventSource:
allOf:
- $ref: "#/components/schemas/SelfManagedEventSource"
- description: The self-managed Apache Kafka cluster to receive records from.
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.
RoleArn:
type: string
pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
Handler:
type: string
pattern: "[^\\s]+"
maxLength: 128
FunctionCode:
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: 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.
Timeout:
type: integer
minimum: 1
MemorySize:
type: integer
minimum: 128
maximum: 10240
VpcConfig:
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.
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.
PackageType:
type: string
enum:
- Zip
- Image
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.
Environment:
type: object
properties:
Variables:
allOf:
- $ref: "#/components/schemas/EnvironmentVariables"
- description: Environment variable key-value pairs. For more information, see Using Lambda environment variables.
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.
KMSKeyArn:
type: string
pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
TracingConfig:
type: object
properties:
Mode:
allOf:
- $ref: "#/components/schemas/TracingMode"
- description: The tracing mode.
description: The function's X-Ray tracing configuration. To sample and record incoming requests, set Mode to Active.
Tags:
type: object
additionalProperties:
$ref: "#/components/schemas/TagValue"
LayerList:
type: array
items:
$ref: "#/components/schemas/LayerVersionArn"
FileSystemConfigList:
type: array
items:
$ref: "#/components/schemas/FileSystemConfig"
maxItems: 1
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.
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.
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.
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.
The name of the Lambda function.
Name formats
Function name – my-function.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN – 123456789012:function:my-function.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
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 Amazon Resource Name (ARN) of the function's execution role. Handler: allOf: - $ref: "#/components/schemas/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. Code: allOf: - $ref: "#/components/schemas/FunctionCode" - description: The code for the function. Description: allOf: - $ref: "#/components/schemas/Description" - description: A description of the function. Timeout: allOf: - $ref: "#/components/schemas/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. MemorySize: allOf: - $ref: "#/components/schemas/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. Publish: allOf: - $ref: "#/components/schemas/Boolean" - description: Set to true to publish the first version of the function during creation. VpcConfig: allOf: - $ref: "#/components/schemas/VpcConfig" - description: For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC. PackageType: allOf: - $ref: "#/components/schemas/PackageType" - description: The type of deployment package. Set toImage for container image and set to Zip for .zip file archive.
DeadLetterConfig:
allOf:
- $ref: "#/components/schemas/DeadLetterConfig"
- description: A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues.
Environment:
allOf:
- $ref: "#/components/schemas/Environment"
- description: Environment variables that are accessible from function code during execution.
KMSKeyArn:
allOf:
- $ref: "#/components/schemas/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.
TracingConfig:
allOf:
- $ref: "#/components/schemas/TracingConfig"
- description: Set Mode to Active to sample and trace a subset of incoming requests with X-Ray.
Tags:
allOf:
- $ref: "#/components/schemas/Tags"
- description: A list of tags to apply to the function.
Layers:
allOf:
- $ref: "#/components/schemas/LayerList"
- description: A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
FileSystemConfigs:
allOf:
- $ref: "#/components/schemas/FileSystemConfigList"
- description: Connection settings for an Amazon EFS file system.
ImageConfig:
allOf:
- $ref: "#/components/schemas/ImageConfig"
- description: Container image configuration values that override the values in the container image Dockerfile.
CodeSigningConfigArn:
allOf:
- $ref: "#/components/schemas/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.
Architectures:
allOf:
- $ref: "#/components/schemas/ArchitecturesList"
- 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.
EphemeralStorage:
allOf:
- $ref: "#/components/schemas/EphemeralStorage"
- description: The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.
SnapStart:
allOf:
- $ref: "#/components/schemas/SnapStart"
- description: The function's SnapStart setting.
FunctionUrlQualifier:
type: string
pattern: (^\$LATEST$)|((?!^[0-9]+$)([a-zA-Z0-9-_]+))
minLength: 1
maxLength: 128
InvokeMode:
type: string
enum:
- BUFFERED
- RESPONSE_STREAM
CreateFunctionUrlConfigRequest:
type: object
required:
- AuthType
title: CreateFunctionUrlConfigRequest
properties:
AuthType:
allOf:
- $ref: "#/components/schemas/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.
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
FilterCriteria object that defines an event filtering pattern. "
FunctionArnList:
type: array
items:
$ref: "#/components/schemas/FunctionArn"
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.
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
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-_]+))?
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.
TracingConfigResponse:
type: object
properties:
Mode:
allOf:
- $ref: "#/components/schemas/TracingMode"
- description: The tracing mode.
description: The function's X-Ray tracing configuration.
LayersReferenceList:
type: array
items:
$ref: "#/components/schemas/Layer"
State:
type: string
enum:
- Pending
- Active
- Inactive
- Failed
StateReason:
type: string
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
LastUpdateStatus:
type: string
enum:
- Successful
- Failed
- InProgress
LastUpdateStatusReason:
type: string
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
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.
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.
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.
MaximumRetryAttempts:
type: integer
minimum: 0
maximum: 2
MaximumEventAgeInSeconds:
type: integer
minimum: 60
maximum: 21600
FunctionEventInvokeConfigList:
type: array
items:
$ref: "#/components/schemas/FunctionEventInvokeConfig"
FunctionList:
type: array
items:
$ref: "#/components/schemas/FunctionConfiguration"
FunctionUrlConfig:
type: object
required:
- FunctionUrl
- FunctionArn
- CreationTime
- LastModifiedTime
- AuthType
properties:
FunctionUrl:
allOf:
- $ref: "#/components/schemas/FunctionUrl"
- description: The HTTP URL endpoint for your function.
FunctionArn:
allOf:
- $ref: "#/components/schemas/FunctionArn"
- description: The Amazon Resource Name (ARN) of your function.
CreationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
AuthType:
allOf:
- $ref: "#/components/schemas/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.
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.
GetFunctionConfiguration.
InvocationType:
type: string
enum:
- Event
- RequestResponse
- DryRun
LogType:
type: string
enum:
- None
- Tail
InvocationRequest:
type: object
title: InvocationRequest
properties:
Payload:
allOf:
- $ref: "#/components/schemas/Blob"
- 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.
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.
InvokeComplete object.
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.
LayerVersionContentInput:
type: object
properties:
S3Bucket:
allOf:
- $ref: "#/components/schemas/S3Bucket"
- description: The Amazon S3 bucket of the layer archive.
S3Key:
allOf:
- $ref: "#/components/schemas/S3Key"
- description: The Amazon S3 key of the layer archive.
S3ObjectVersion:
allOf:
- $ref: "#/components/schemas/S3ObjectVersion"
- description: For versioned objects, the version of the layer archive object to use.
ZipFile:
allOf:
- $ref: "#/components/schemas/Blob"
- description: The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
description: A ZIP archive that contains the contents of an Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.
LayerVersionsListItem:
type: object
properties:
LayerVersionArn:
allOf:
- $ref: "#/components/schemas/LayerVersionArn"
- description: The ARN of the layer version.
Version:
allOf:
- $ref: "#/components/schemas/LayerVersionNumber"
- description: The version number.
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: The description of the version.
CreatedDate:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.
CompatibleRuntimes:
allOf:
- $ref: "#/components/schemas/CompatibleRuntimes"
- description: The layer's compatible runtimes.
LicenseInfo:
allOf:
- $ref: "#/components/schemas/LicenseInfo"
- description: The layer's open-source license.
CompatibleArchitectures:
allOf:
- $ref: "#/components/schemas/CompatibleArchitectures"
- description: A list of compatible instruction set architectures.
description: Details about a version of an Lambda layer.
LayerVersionsList:
type: array
items:
$ref: "#/components/schemas/LayerVersionsListItem"
LayersListItem:
type: object
properties:
LayerName:
allOf:
- $ref: "#/components/schemas/LayerName"
- description: The name of the layer.
LayerArn:
allOf:
- $ref: "#/components/schemas/LayerArn"
- description: The Amazon Resource Name (ARN) of the function layer.
LatestMatchingVersion:
allOf:
- $ref: "#/components/schemas/LayerVersionsListItem"
- description: The newest version of the layer.
description: Details about an Lambda layer.
LayersList:
type: array
items:
$ref: "#/components/schemas/LayersListItem"
MaxListItems:
type: integer
minimum: 1
maximum: 10000
ListAliasesRequest:
type: object
title: ListAliasesRequest
properties: {}
ListCodeSigningConfigsRequest:
type: object
title: ListCodeSigningConfigsRequest
properties: {}
ListEventSourceMappingsRequest:
type: object
title: ListEventSourceMappingsRequest
properties: {}
MaxFunctionEventInvokeConfigListItems:
type: integer
minimum: 1
maximum: 50
ListFunctionEventInvokeConfigsRequest:
type: object
title: ListFunctionEventInvokeConfigsRequest
properties: {}
MaxItems:
type: integer
minimum: 1
maximum: 50
ListFunctionUrlConfigsRequest:
type: object
title: ListFunctionUrlConfigsRequest
properties: {}
ListFunctionsByCodeSigningConfigRequest:
type: object
title: ListFunctionsByCodeSigningConfigRequest
properties: {}
MasterRegion:
type: string
pattern: ALL|[a-z]{2}(-gov)?-[a-z]+-\d{1}
ListFunctionsRequest:
type: object
title: ListFunctionsRequest
properties: {}
MaxLayerListItems:
type: integer
minimum: 1
maximum: 50
ListLayerVersionsRequest:
type: object
title: ListLayerVersionsRequest
properties: {}
ListLayersRequest:
type: object
title: ListLayersRequest
properties: {}
MaxProvisionedConcurrencyConfigListItems:
type: integer
minimum: 1
maximum: 50
ListProvisionedConcurrencyConfigsRequest:
type: object
title: ListProvisionedConcurrencyConfigsRequest
properties: {}
ProvisionedConcurrencyConfigList:
type: array
items:
$ref: "#/components/schemas/ProvisionedConcurrencyConfigListItem"
ListTagsRequest:
type: object
title: ListTagsRequest
properties: {}
ListVersionsByFunctionRequest:
type: object
title: ListVersionsByFunctionRequest
properties: {}
NamespacedStatementId:
type: string
pattern: ([a-zA-Z0-9-_.]+)
minLength: 1
maxLength: 100
ProvisionedConcurrencyConfigListItem:
type: object
properties:
FunctionArn:
allOf:
- $ref: "#/components/schemas/FunctionArn"
- description: The Amazon Resource Name (ARN) of the alias or version.
RequestedProvisionedConcurrentExecutions:
allOf:
- $ref: "#/components/schemas/PositiveInteger"
- description: The amount of provisioned concurrency requested.
AvailableProvisionedConcurrentExecutions:
allOf:
- $ref: "#/components/schemas/NonNegativeInteger"
- description: The amount of provisioned concurrency available.
AllocatedProvisionedConcurrentExecutions:
allOf:
- $ref: "#/components/schemas/NonNegativeInteger"
- description: The amount of provisioned concurrency allocated. When a weighted alias is used during linear and canary deployments, this value fluctuates depending on the amount of concurrency that is provisioned for the function versions.
Status:
allOf:
- $ref: "#/components/schemas/ProvisionedConcurrencyStatusEnum"
- description: The status of the allocation process.
StatusReason:
allOf:
- $ref: "#/components/schemas/String"
- description: For failed allocations, the reason that provisioned concurrency could not be allocated.
LastModified:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The date and time that a user last updated the configuration, in ISO 8601 format.
description: Details about the provisioned concurrency configuration for a function alias or version.
PublishLayerVersionRequest:
type: object
required:
- Content
title: PublishLayerVersionRequest
properties:
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: The description of the version.
Content:
allOf:
- $ref: "#/components/schemas/LayerVersionContentInput"
- description: The function layer archive.
CompatibleRuntimes:
allOf:
- $ref: "#/components/schemas/CompatibleRuntimes"
- description: A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.
LicenseInfo:
allOf:
- $ref: "#/components/schemas/LicenseInfo"
- description: The layer's software license. It can be any of the following:
An SPDX license identifier. For example, MIT.
The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.
The full text of the license.
A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
Specify the runtime update mode.
Auto (default) - Automatically update to the most recent and secure runtime version using a Two-phase runtime version rollout. This is the best choice for most customers to ensure they always benefit from runtime updates.
Function update - Lambda updates the runtime of your function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date.
Manual - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see Roll back a runtime version.
The ARN of the runtime version you want the function to use.
This is only required if you're using the Manual runtime update mode.
The name of the Lambda function.
Name formats
Function name – MyFunction.
Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.
Enabled: allOf: - $ref: "#/components/schemas/Enabled" - description: "When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
Default: True
" 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).
Amazon Kinesis – Default 100. Max 10,000.
Amazon DynamoDB Streams – Default 100. Max 10,000.
Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
Self-managed Apache Kafka – Default 100. Max 10,000.
Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
DocumentDB – Default 100. Max 10,000.
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.
x86_64.
UpdateFunctionConfigurationRequest:
type: object
title: UpdateFunctionConfigurationRequest
properties:
Role:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: The Amazon Resource Name (ARN) of the function's execution role.
Handler:
allOf:
- $ref: "#/components/schemas/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.
Description:
allOf:
- $ref: "#/components/schemas/Description"
- description: A description of the function.
Timeout:
allOf:
- $ref: "#/components/schemas/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.
MemorySize:
allOf:
- $ref: "#/components/schemas/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.
VpcConfig:
allOf:
- $ref: "#/components/schemas/VpcConfig"
- description: For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see Configuring a Lambda function to access resources in a VPC.
Environment:
allOf:
- $ref: "#/components/schemas/Environment"
- description: Environment variables that are accessible from function code during execution.
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.
DeadLetterConfig: allOf: - $ref: "#/components/schemas/DeadLetterConfig" - description: A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead-letter queues. KMSKeyArn: allOf: - $ref: "#/components/schemas/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. TracingConfig: allOf: - $ref: "#/components/schemas/TracingConfig" - description: SetMode to Active to sample and trace a subset of incoming requests with X-Ray.
RevisionId:
allOf:
- $ref: "#/components/schemas/String"
- 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.
Layers:
allOf:
- $ref: "#/components/schemas/LayerList"
- description: A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.
FileSystemConfigs:
allOf:
- $ref: "#/components/schemas/FileSystemConfigList"
- description: Connection settings for an Amazon EFS file system.
ImageConfig:
allOf:
- $ref: "#/components/schemas/ImageConfig"
- description: ' Container image configuration values that override the values in the container image Docker file.'
EphemeralStorage:
allOf:
- $ref: "#/components/schemas/EphemeralStorage"
- description: The size of the function's /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10,240 MB.
SnapStart:
allOf:
- $ref: "#/components/schemas/SnapStart"
- description: The function's SnapStart setting.
UpdateFunctionEventInvokeConfigRequest:
type: object
title: UpdateFunctionEventInvokeConfigRequest
properties:
MaximumRetryAttempts:
allOf:
- $ref: "#/components/schemas/MaximumRetryAttempts"
- description: The maximum number of times to retry when the function returns an error.
MaximumEventAgeInSeconds:
allOf:
- $ref: "#/components/schemas/MaximumEventAgeInSeconds"
- description: The maximum age of a request that Lambda sends to a function for processing.
DestinationConfig:
allOf:
- $ref: "#/components/schemas/DestinationConfig"
- description: A destination for events after they have been sent to a function for processing.
Destinations
Function - The Amazon Resource Name (ARN) of a Lambda function.
Queue - The ARN of a standard SQS queue.
Topic - The ARN of a standard SNS topic.
Event Bus - The ARN of an Amazon EventBridge event bus.
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.
Cors:
allOf:
- $ref: "#/components/schemas/Cors"
- description: The cross-origin resource sharing (CORS) settings for your function URL.
InvokeMode:
allOf:
- $ref: "#/components/schemas/InvokeMode"
- description: Use one of the following options:
BUFFERED – This is the default option. Lambda invokes your function using the Invoke API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes your function using the InvokeWithResponseStream API operation. The maximum response payload size is 20 MB, however, you can request a quota increase.