openapi: 3.2.0 info: version: 2015-03-31 x-release: v4 title: AWS Lambda Functions API description: 'Lambda Overview Lambda is a compute service that lets you run code without provisioning or managing servers.' 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 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) security: - hmac: [] tags: - name: Functions paths: /2015-03-31/functions/{FunctionName}/policy: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: AddPermission description: 'Grants an Amazon Web Service, Amazon Web Services account, or Amazon Web Services organization permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST. To grant permission to another account, specify the account ID as the Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Services, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function. This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda.' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/AddPermissionResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: PolicyLengthExceededException content: application/json: schema: $ref: '#/components/schemas/PolicyLengthExceededException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '486': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' parameters: - name: FunctionName in: path required: true description:
The name of the Lambda function, version, or alias.
Name formats
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:
- Functions
summary: Add permission
x-summary-source: derived
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: - Functions summary: Get policy x-summary-source: derived /2015-03-31/functions/{FunctionName}/aliases: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateAlias description: 'Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version. You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/AliasConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
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: - Functions summary: Create alias x-summary-source: derived 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: - Functions summary: List aliases x-summary-source: derived /2015-03-31/functions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateFunction description: 'Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing. If the deployment package is a container image, then you set the package type to Image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties. If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64. When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can''t invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Lambda function states. A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function''s code and configuration. A published version is a snapshot of your function code and configuration that can''t be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration. The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency). You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted publishers for this function. If another Amazon Web Services account or an Amazon Web Service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '484': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '485': description: CodeStorageExceededException content: application/json: schema: $ref: '#/components/schemas/CodeStorageExceededException' '486': description: CodeVerificationFailedException content: application/json: schema: $ref: '#/components/schemas/CodeVerificationFailedException' '487': description: InvalidCodeSignatureException content: application/json: schema: $ref: '#/components/schemas/InvalidCodeSignatureException' '488': description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: '#/components/schemas/CodeSigningConfigNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - FunctionName - Role - Code properties: FunctionName: description:The name of the Lambda function.
Name formats
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:
- Functions
summary: Create function
x-summary-source: derived
/2021-10-31/functions/{FunctionName}/url:
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: 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: - Functions summary: Delete function url config x-summary-source: derived 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: - Functions summary: Get function url config x-summary-source: derived 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: - Functions summary: Delete alias x-summary-source: derived 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: - Functions summary: Get alias x-summary-source: derived 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: - Functions summary: Update alias x-summary-source: derived /2015-03-31/functions/{FunctionName}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteFunction description: 'Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.' responses: '204': description: Success '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '484': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function or version.
Name formats
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: - Functions summary: Delete function x-summary-source: derived 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: - Functions summary: Get function x-summary-source: derived /2020-06-30/functions/{FunctionName}/code-signing-config: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: 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: - Functions summary: Delete function code signing config x-summary-source: derived 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: - Functions summary: Get function code signing config x-summary-source: derived 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: - Functions summary: Put function code signing config x-summary-source: derived /2017-10-31/functions/{FunctionName}/concurrency: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: 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: - Functions summary: Delete function concurrency x-summary-source: derived 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: - Functions summary: Put function concurrency x-summary-source: derived /2019-09-25/functions/{FunctionName}/event-invoke-config: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: 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: - Functions summary: Delete function event invoke config x-summary-source: derived 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: - Functions summary: Get function event invoke config x-summary-source: derived 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: - Functions summary: Put function event invoke config x-summary-source: derived 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: - Functions summary: Update function event invoke config x-summary-source: derived /2019-09-30/functions/{FunctionName}/provisioned-concurrency#Qualifier: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: 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: - Functions summary: Delete provisioned concurrency config x-summary-source: derived 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: - Functions summary: Get provisioned concurrency config x-summary-source: derived 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: - Functions summary: Put provisioned concurrency config x-summary-source: derived /2019-09-30/functions/{FunctionName}/concurrency: 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: 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: - Functions summary: Get function concurrency x-summary-source: derived /2015-03-31/functions/{FunctionName}/configuration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetFunctionConfiguration description: 'Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration. To get all of a function''s details, including function-level settings, use GetFunction.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '483': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function, version, or alias.
Name formats
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: - Functions summary: Get function configuration x-summary-source: derived 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:
- Functions
summary: Update function configuration
x-summary-source: derived
/2021-07-20/functions/{FunctionName}/runtime-management-config:
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: 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:
- Functions
summary: Get runtime management config
x-summary-source: derived
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.
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.
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: - Functions summary: Invoke async x-summary-source: derived /2021-11-15/functions/{FunctionName}/response-streaming-invocations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: 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.
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: - Functions summary: List function event invoke configs x-summary-source: derived /2021-10-31/functions/{FunctionName}/urls: 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: 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:
- Functions
summary: List function url configs
x-summary-source: derived
/2015-03-31/functions/:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListFunctions
description: 'Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.
The ListFunctions operation returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig) for a function or version, use GetFunction.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFunctionsResponse'
'480':
description: ServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceException'
'481':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
'482':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
parameters:
- name: MasterRegion
in: query
required: false
description: For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 filters the list of functions to include only Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.
schema:
type: string
pattern: ALL|[a-z]{2}(-gov)?-[a-z]+-\d{1}
- name: FunctionVersion
in: query
required: false
description: Set to ALL to include entries for all published versions of each function.
schema:
type: string
enum:
- ALL
- name: Marker
in: query
required: false
description: Specify the pagination token that's returned by a previous request to retrieve the next page of results.
schema:
type: string
- name: MaxItems
in: query
required: false
description: The maximum number of functions to return in the response. Note that ListFunctions returns a maximum of 50 items in each response, even if you set the number higher.
schema:
type: integer
minimum: 1
maximum: 10000
tags:
- Functions
summary: List functions
x-summary-source: derived
/2019-09-30/functions/{FunctionName}/provisioned-concurrency#List=ALL:
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: 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: - Functions summary: List provisioned concurrency configs x-summary-source: derived /2015-03-31/functions/{FunctionName}/versions: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListVersionsByFunction description: Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVersionsByFunctionResponse' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
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:
- Functions
summary: List versions by function
x-summary-source: derived
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: - Functions summary: Publish version x-summary-source: derived /2015-03-31/functions/{FunctionName}/policy/{StatementId}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: RemovePermission description: Revokes function-use permission from an Amazon Web Service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy. responses: '204': description: Success '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function, version, or alias.
Name formats
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: - Functions summary: Remove permission x-summary-source: derived /2015-03-31/functions/{FunctionName}/code: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateFunctionCode description: 'Updates a Lambda function''s code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing for Lambda. If the function''s package type is Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry. If the function''s package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). The function''s code is locked when you publish a version. You can''t modify the code of a published version, only the unpublished version. For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FunctionConfiguration' '480': description: ServiceException content: application/json: schema: $ref: '#/components/schemas/ServiceException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: InvalidParameterValueException content: application/json: schema: $ref: '#/components/schemas/InvalidParameterValueException' '483': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' '484': description: CodeStorageExceededException content: application/json: schema: $ref: '#/components/schemas/CodeStorageExceededException' '485': description: PreconditionFailedException content: application/json: schema: $ref: '#/components/schemas/PreconditionFailedException' '486': description: ResourceConflictException content: application/json: schema: $ref: '#/components/schemas/ResourceConflictException' '487': description: CodeVerificationFailedException content: application/json: schema: $ref: '#/components/schemas/CodeVerificationFailedException' '488': description: InvalidCodeSignatureException content: application/json: schema: $ref: '#/components/schemas/InvalidCodeSignatureException' '489': description: CodeSigningConfigNotFoundException content: application/json: schema: $ref: '#/components/schemas/CodeSigningConfigNotFoundException' parameters: - name: FunctionName in: path required: true description:The name of the Lambda function.
Name formats
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:
- Functions
summary: Update function code
x-summary-source: derived
components:
schemas:
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.
ImageConfigError:
type: object
properties:
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- description: Error code.
Message:
allOf:
- $ref: '#/components/schemas/SensitiveString'
- description: Error message.
description: Error response to GetFunctionConfiguration.
SnapStartException: {}
Header:
type: string
pattern: .*
maxLength: 1024
InvalidCodeSignatureException: {}
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.
Integer:
type: integer
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.
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.
202 Accepted) indicates that the request is queued for invocation.
CodeStorageExceededException: {}
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.
HeadersList:
type: array
items:
$ref: '#/components/schemas/Header'
maxItems: 100
EnvironmentVariableValue:
type: string
format: password
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.
AddPermissionResponse:
type: object
properties:
Statement:
allOf:
- $ref: '#/components/schemas/String'
- description: The permission statement that's added to the function policy.
FunctionUrlConfigList:
type: array
items:
$ref: '#/components/schemas/FunctionUrlConfig'
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-_]+))?
MaximumRetryAttempts:
type: integer
minimum: 0
maximum: 2
EFSIOException: {}
PolicyLengthExceededException: {}
FunctionEventInvokeConfigList:
type: array
items:
$ref: '#/components/schemas/FunctionEventInvokeConfig'
EnvironmentResponse:
type: object
properties:
Variables:
allOf:
- $ref: '#/components/schemas/EnvironmentVariables'
- description: Environment variable key-value pairs. Omitted from CloudTrail logs.
Error:
allOf:
- $ref: '#/components/schemas/EnvironmentError'
- description: Error messages for environment variables that couldn't be applied.
description: The results of an operation to update or read environment variables. If the operation succeeds, the response contains the environment variables. If it fails, the response contains details about the error.
AdditionalVersionWeights:
type: object
additionalProperties:
$ref: '#/components/schemas/Weight'
PackageType:
type: string
enum:
- Zip
- Image
FileSystemConfig:
type: object
required:
- Arn
- LocalMountPath
properties:
Arn:
allOf:
- $ref: '#/components/schemas/FileSystemArn'
- description: The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.
LocalMountPath:
allOf:
- $ref: '#/components/schemas/LocalMountPath'
- description: The path where the function can access the file system, starting with /mnt/.
description: Details about the connection between a Lambda function and an Amazon EFS file system.
Date:
type: string
format: date-time
UpdateRuntimeOn:
type: string
enum:
- Auto
- Manual
- FunctionUpdate
InvokeResponseStreamUpdate:
type: object
properties:
Payload:
allOf:
- $ref: '#/components/schemas/Blob'
- description: Data returned by your Lambda function.
description: A chunk of the streamed response payload.
Origin:
type: string
pattern: .*
minLength: 1
maxLength: 253
TagValue:
type: string
SecurityGroupId:
type: string
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.
SnapStartOptimizationStatus:
type: string
enum:
- 'On'
- 'Off'
InvalidSecurityGroupIDException: {}
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.
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.
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.
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.
AllowCredentials:
type: boolean
MemorySize:
type: integer
minimum: 128
maximum: 10240
LastUpdateStatusReason:
type: string
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.
AllowOriginsList:
type: array
items:
$ref: '#/components/schemas/Origin'
maxItems: 100
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
AliasList:
type: array
items:
$ref: '#/components/schemas/AliasConfiguration'
AllowMethodsList:
type: array
items:
$ref: '#/components/schemas/Method'
maxItems: 6
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.
InvalidParameterValueException: {}
Blob:
type: string
format: password
SnapStartNotReadyException: {}
ReservedConcurrentExecutions:
type: integer
minimum: 0
Method:
type: string
pattern: .*
maxLength: 6
EC2AccessDeniedException: {}
CodeSigningConfigNotFoundException: {}
RequestTooLargeException: {}
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.
GetFunctionUrlConfigResponse:
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.
GetFunctionConfiguration request.
Alias:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)
minLength: 1
maxLength: 128
InvalidRuntimeException: {}
Timeout:
type: integer
minimum: 1
ServiceException: {}
Tags:
type: object
additionalProperties:
$ref: '#/components/schemas/TagValue'
FunctionList:
type: array
items:
$ref: '#/components/schemas/FunctionConfiguration'
VpcId:
type: string
MaxAge:
type: integer
minimum: 0
maximum: 86400
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
NonNegativeInteger:
type: integer
minimum: 0
Handler:
type: string
pattern: '[^\s]+'
maxLength: 128
GetFunctionCodeSigningConfigResponse:
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.
SubnetIPAddressLimitReachedException: {} StateReason: type: string UnsupportedMediaTypeException: {} 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. 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. WorkingDirectory: type: string maxLength: 1000 Arn: type: string pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*) S3ObjectVersion: type: string minLength: 1 maxLength: 1024 MaximumEventAgeInSeconds: type: integer minimum: 60 maximum: 21600 InvalidSubnetIDException: {} GetFunctionConcurrencyResponse: type: object properties: ReservedConcurrentExecutions: allOf: - $ref: '#/components/schemas/ReservedConcurrentExecutions' - description: The number of simultaneous executions that are reserved for the function. LayersReferenceList: type: array items: $ref: '#/components/schemas/Layer' SnapStartApplyOn: type: string enum: - PublishedVersions - None KMSAccessDeniedException: {} 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 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. Description: type: string minLength: 0 maxLength: 256 RuntimeVersionArn: type: string pattern: ^arn:(aws[a-zA-Z-]*):lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}::runtime:.+$ minLength: 26 maxLength: 2048 LastUpdateStatus: type: string enum: - Successful - Failed - InProgress EC2UnexpectedException: {} 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. 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. Architecture: type: string enum: - x86_64 - arm64 StringList: type: array items: $ref: '#/components/schemas/String' maxItems: 1500 FileSystemConfigList: type: array items: $ref: '#/components/schemas/FileSystemConfig' maxItems: 1 InvokeWithResponseStreamResponseEvent: type: object properties: PayloadChunk: allOf: - $ref: '#/components/schemas/InvokeResponseStreamUpdate' - description: A chunk of the streamed response payload. InvokeComplete: allOf: - $ref: '#/components/schemas/InvokeWithResponseStreamCompleteEvent' - description: An object that's returned when the stream has ended and all the payload chunks have been returned. description: An object that includes a chunk of the response payload. When the stream has ended, Lambda includes aInvokeComplete object.
RoleArn:
type: string
pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
PreconditionFailedException: {}
HttpStatus:
type: integer
ENILimitReachedException: {}
ProvisionedConcurrencyConfigList:
type: array
items:
$ref: '#/components/schemas/ProvisionedConcurrencyConfigListItem'
SnapStartTimeoutException: {}
LocalMountPath:
type: string
pattern: ^/mnt/[a-zA-Z0-9-_.]+$
maxLength: 160
DestinationArn:
type: string
pattern: ^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)
minLength: 0
maxLength: 350
SensitiveString:
type: string
format: password
GetProvisionedConcurrencyConfigResponse:
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.
Long:
type: integer
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.
TracingMode:
type: string
enum:
- Active
- PassThrough
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.
EC2ThrottledException: {}
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.
EphemeralStorageSize: type: integer minimum: 512 maximum: 10240 RuntimeVersionError: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/String' - description: The error code. Message: allOf: - $ref: '#/components/schemas/SensitiveString' - description: The error message. description: Any error returned when the runtime version information for the function could not be retrieved. 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.
EFSMountTimeoutException: {}
TooManyRequestsException: {}
State:
type: string
enum:
- Pending
- Active
- Inactive
- Failed
GetRuntimeManagementConfigResponse:
type: object
properties:
UpdateRuntimeOn:
allOf:
- $ref: '#/components/schemas/UpdateRuntimeOn'
- description: The current runtime update mode 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, otherwise null is returned.
FunctionArn:
allOf:
- $ref: '#/components/schemas/NameSpacedFunctionArn'
- description: The Amazon Resource Name (ARN) of your function.
GetPolicyResponse:
type: object
properties:
Policy:
allOf:
- $ref: '#/components/schemas/String'
- description: The resource-based policy.
RevisionId:
allOf:
- $ref: '#/components/schemas/String'
- description: A unique identifier for the current revision of the policy.
EnvironmentError:
type: object
properties:
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/SensitiveString'
- description: The error message.
description: Error messages for environment variables that couldn't be applied.
InvalidZipFileException: {}
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
Timestamp:
type: string
LayerVersionArn:
type: string
pattern: arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+
minLength: 1
maxLength: 140
EFSMountFailureException: {}
FunctionUrlAuthType:
type: string
enum:
- NONE
- AWS_IAM
S3Key:
type: string
minLength: 1
maxLength: 1024
SubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
maxItems: 16
InvokeWithResponseStreamCompleteEvent:
type: object
properties:
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- description: An error code.
ErrorDetails:
allOf:
- $ref: '#/components/schemas/String'
- description: The details of any returned error.
LogResult:
allOf:
- $ref: '#/components/schemas/String'
- description: The last 4 KB of the execution log, which is base64-encoded.
description: A response confirming that the event stream is complete.
Cors:
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.
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.
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-_]+))?
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
KMSKeyArn:
type: string
pattern: (arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()
CodeVerificationFailedException: {}
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.
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
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
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/lambda/
x-hasEquivalentPaths: true