Limits that are related to concurrency and storage. All file and storage sizes are in bytes.
*/ export interface AccountLimit { /** *The amount of storage space that you can use for all deployment packages and layer archives.
*/ TotalCodeSize?: number; /** *The maximum size of a function's deployment package and layers when they're extracted.
*/ CodeSizeUnzipped?: number; /** *The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger * files.
*/ CodeSizeZipped?: number; /** *The maximum number of simultaneous function executions.
*/ ConcurrentExecutions?: number; /** *The maximum number of simultaneous function executions, minus the capacity that's reserved for individual * functions with PutFunctionConcurrency.
*/ UnreservedConcurrentExecutions?: number; } /** * @public *The number of functions and amount of storage in use.
*/ export interface AccountUsage { /** *The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
*/ TotalCodeSize?: number; /** *The number of Lambda functions.
*/ FunctionCount?: number; } /** * @public */ export interface AddLayerVersionPermissionRequest { /** *The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The version number.
*/ VersionNumber: number | undefined; /** *An identifier that distinguishes the policy from others on the same layer version.
*/ StatementId: string | undefined; /** *The API action that grants access to the layer. For example, lambda:GetLayerVersion.
An account ID, or * to grant layer usage permission to all
* accounts in an organization, or all Amazon Web Services accounts (if organizationId is not specified).
* For the last case, make sure that you really do want all Amazon Web Services accounts to have usage permission to this layer.
*
With the principal set to *, grant permission to all accounts in the specified
* organization.
Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a * policy that has changed since you last read it.
*/ RevisionId?: string; } /** * @public */ export interface AddLayerVersionPermissionResponse { /** *The permission statement.
*/ Statement?: string; /** *A unique identifier for the current revision of the policy.
*/ RevisionId?: string; } /** * @public *One of the parameters in the request is not valid.
*/ export declare class InvalidParameterValueException extends __BaseException { readonly name: "InvalidParameterValueException"; readonly $fault: "client"; /** *The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe permissions policy for the resource is too large. For more information, see Lambda quotas.
*/ export declare class PolicyLengthExceededException extends __BaseException { readonly name: "PolicyLengthExceededException"; readonly $fault: "client"; Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias
* API operation to retrieve the latest RevisionId for your resource.
The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe resource already exists, or another operation is in progress.
*/ export declare class ResourceConflictException extends __BaseException { readonly name: "ResourceConflictException"; readonly $fault: "client"; /** *The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe resource specified in the request does not exist.
*/ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe Lambda service encountered an internal error.
*/ export declare class ServiceException extends __BaseException { readonly name: "ServiceException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe request throughput limit was exceeded. For more information, see Lambda quotas.
*/ export declare class TooManyRequestsException extends __BaseException { readonly name: "TooManyRequestsException"; readonly $fault: "client"; /** *The number of seconds the caller should wait before retrying.
*/ retryAfterSeconds?: string; Type?: string; Reason?: ThrottleReason | string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ FunctionName: string | undefined; /** *A statement identifier that differentiates the statement from others in the same policy.
*/ StatementId: string | undefined; /** *The action that the principal can use on the function. For example, lambda:InvokeFunction or
* lambda:GetFunction.
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.
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.
For Amazon Web Service, the ID of the Amazon Web Services account that owns the resource. Use this
* together with SourceArn to ensure that the specified account owns the resource. It is possible for an
* Amazon S3 bucket to be deleted by its owner and recreated by another account.
For Alexa Smart Home functions, a token that the invoker must supply.
*/ EventSourceToken?: string; /** *Specify a version or alias to add permissions to a published version of the function.
*/ Qualifier?: string; /** *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.
*/ RevisionId?: string; /** *The identifier for your organization in Organizations. Use this to grant permissions to all the * Amazon Web Services accounts under this organization.
*/ PrincipalOrgID?: string; /** *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.
The permission statement that's added to the function policy.
*/ Statement?: string; } /** * @public *The traffic-shifting configuration of a Lambda function alias.
*/ export interface AliasRoutingConfiguration { /** *The second version, and the percentage of traffic that's routed to it.
*/ AdditionalVersionWeights?: RecordProvides configuration information about a Lambda function alias.
*/ export interface AliasConfiguration { /** *The Amazon Resource Name (ARN) of the alias.
*/ AliasArn?: string; /** *The name of the alias.
*/ Name?: string; /** *The function version that the alias invokes.
*/ FunctionVersion?: string; /** *A description of the alias.
*/ Description?: string; /** *The routing * configuration of the alias.
*/ RoutingConfig?: AliasRoutingConfiguration; /** *A unique identifier that changes when you update the alias.
*/ RevisionId?: string; } /** * @public *List of signing profiles that can sign a code package.
*/ export interface AllowedPublishers { /** *The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user * who can sign a code package.
*/ SigningProfileVersionArns: string[] | undefined; } /** * @public *Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
*/ export interface AmazonManagedKafkaEventSourceConfig { /** *The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. * After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see * Customizable consumer group ID.
*/ ConsumerGroupId?: string; } /** * @public * @enum */ export declare const Architecture: { readonly arm64: "arm64"; readonly x86_64: "x86_64"; }; /** * @public */ export type Architecture = (typeof Architecture)[keyof typeof Architecture]; /** * @public */ export interface CreateAliasRequest { /** *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.
*/ FunctionName: string | undefined; /** *The name of the alias.
*/ Name: string | undefined; /** *The function version that the alias invokes.
*/ FunctionVersion: string | undefined; /** *A description of the alias.
*/ Description?: string; /** *The routing * configuration of the alias.
*/ RoutingConfig?: AliasRoutingConfiguration; } /** * @public * @enum */ export declare const CodeSigningPolicy: { readonly Enforce: "Enforce"; readonly Warn: "Warn"; }; /** * @public */ export type CodeSigningPolicy = (typeof CodeSigningPolicy)[keyof typeof CodeSigningPolicy]; /** * @public *Code signing configuration policies specify the validation failure action for signature mismatch or * expiry.
*/ export interface CodeSigningPolicies { /** *Code signing configuration policy for deployment validation failure. If you set the policy to
* Enforce, Lambda blocks the deployment request if signature validation checks fail. If you set the
* policy to Warn, Lambda allows the deployment and creates a CloudWatch log.
Default value: Warn
*
Descriptive name for this code signing configuration.
*/ Description?: string; /** *Signing profiles for this code signing configuration.
*/ AllowedPublishers: AllowedPublishers | undefined; /** *The code signing policies define the actions to take if the validation checks fail.
*/ CodeSigningPolicies?: CodeSigningPolicies; } /** * @public *Details about a Code signing configuration.
*/ export interface CodeSigningConfig { /** *Unique identifer for the Code signing configuration.
*/ CodeSigningConfigId: string | undefined; /** *The Amazon Resource Name (ARN) of the Code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *Code signing configuration description.
*/ Description?: string; /** *List of allowed publishers.
*/ AllowedPublishers: AllowedPublishers | undefined; /** *The code signing policy controls the validation failure action for signature mismatch or expiry.
*/ CodeSigningPolicies: CodeSigningPolicies | undefined; /** *The date and time that the Code signing configuration was last modified, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ LastModified: string | undefined; } /** * @public */ export interface CreateCodeSigningConfigResponse { /** *The code signing configuration.
*/ CodeSigningConfig: CodeSigningConfig | undefined; } /** * @public *A destination for events that failed processing.
*/ export interface OnFailure { /** *The Amazon Resource Name (ARN) of the destination resource.
*/ Destination?: string; } /** * @public *A destination for events that were processed successfully.
*/ export interface OnSuccess { /** *The Amazon Resource Name (ARN) of the destination resource.
*/ Destination?: string; } /** * @public *A configuration object that specifies the destination of an event after Lambda processes it.
*/ export interface DestinationConfig { /** *The destination configuration for successful invocations.
*/ OnSuccess?: OnSuccess; /** *The destination configuration for failed invocations.
*/ OnFailure?: OnFailure; } /** * @public * @enum */ export declare const FullDocument: { readonly Default: "Default"; readonly UpdateLookup: "UpdateLookup"; }; /** * @public */ export type FullDocument = (typeof FullDocument)[keyof typeof FullDocument]; /** * @public ** Specific configuration settings for a DocumentDB event source. *
*/ export interface DocumentDBEventSourceConfig { /** ** The name of the database to consume within the DocumentDB cluster. *
*/ DatabaseName?: string; /** ** The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. *
*/ CollectionName?: string; /** ** Determines what DocumentDB sends to your event stream during document update operations. If set to UpdateLookup, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. *
*/ FullDocument?: FullDocument | string; } /** * @public *
* A structure within a FilterCriteria object that defines an event filtering pattern.
*
* A filter pattern. For more information on the syntax of a filter pattern, see * * Filter rule syntax. *
*/ Pattern?: string; } /** * @public ** An object that contains the filters for an event source. *
*/ export interface FilterCriteria { /** ** A list of filters. *
*/ Filters?: Filter[]; } /** * @public * @enum */ export declare const FunctionResponseType: { readonly ReportBatchItemFailures: "ReportBatchItemFailures"; }; /** * @public */ export type FunctionResponseType = (typeof FunctionResponseType)[keyof typeof FunctionResponseType]; /** * @public *(Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value.
*/ export interface ScalingConfig { /** *Limits the number of concurrent instances that the Amazon SQS event source can invoke.
*/ MaximumConcurrency?: number; } /** * @public * @enum */ export declare const EndPointType: { readonly KAFKA_BOOTSTRAP_SERVERS: "KAFKA_BOOTSTRAP_SERVERS"; }; /** * @public */ export type EndPointType = (typeof EndPointType)[keyof typeof EndPointType]; /** * @public *The self-managed Apache Kafka cluster for your event source.
*/ export interface SelfManagedEventSource { /** *The list of bootstrap servers for your Kafka brokers in the following format: "KAFKA_BOOTSTRAP_SERVERS":
* ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"].
Specific configuration settings for a self-managed Apache Kafka event source.
*/ export interface SelfManagedKafkaEventSourceConfig { /** *The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. * After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see * Customizable consumer group ID.
*/ ConsumerGroupId?: string; } /** * @public * @enum */ export declare const SourceAccessType: { readonly BASIC_AUTH: "BASIC_AUTH"; readonly CLIENT_CERTIFICATE_TLS_AUTH: "CLIENT_CERTIFICATE_TLS_AUTH"; readonly SASL_SCRAM_256_AUTH: "SASL_SCRAM_256_AUTH"; readonly SASL_SCRAM_512_AUTH: "SASL_SCRAM_512_AUTH"; readonly SERVER_ROOT_CA_CERTIFICATE: "SERVER_ROOT_CA_CERTIFICATE"; readonly VIRTUAL_HOST: "VIRTUAL_HOST"; readonly VPC_SECURITY_GROUP: "VPC_SECURITY_GROUP"; readonly VPC_SUBNET: "VPC_SUBNET"; }; /** * @public */ export type SourceAccessType = (typeof SourceAccessType)[keyof typeof SourceAccessType]; /** * @public *To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host.
*/ export interface SourceAccessConfiguration { /** *The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH".
* BASIC_AUTH – (Amazon MQ) The Secrets Manager secret that stores your broker credentials.
* BASIC_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.
* VPC_SUBNET – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.
* VPC_SECURITY_GROUP – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.
* SASL_SCRAM_256_AUTH – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.
* SASL_SCRAM_512_AUTH – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.
* VIRTUAL_HOST –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source.
* This property cannot be specified in an UpdateEventSourceMapping API call.
* CLIENT_CERTIFICATE_TLS_AUTH – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM),
* private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.
* SERVER_ROOT_CA_CERTIFICATE – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.
*
The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName".
The Amazon Resource Name (ARN) of the event source.
** Amazon Kinesis – The ARN of the data stream or a stream consumer.
** Amazon DynamoDB Streams – The ARN of the stream.
** Amazon Simple Queue Service – The ARN of the queue.
** Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
** Amazon MQ – The ARN of the broker.
** Amazon DocumentDB – The ARN of the DocumentDB change stream.
*The name of the Lambda function.
** Name formats *
*
* Function name – MyFunction.
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
* Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
* Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 * characters in length.
*/ FunctionName: string | undefined; /** *When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
*Default: True
*/ Enabled?: boolean; /** *The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation * (6 MB).
** Amazon Kinesis – Default 100. Max 10,000.
** Amazon DynamoDB Streams – Default 100. Max 10,000.
** Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
** Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
** Self-managed Apache Kafka – Default 100. Max 10,000.
** Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
** DocumentDB – Default 100. Max 10,000.
*An object that defines the filter criteria that * determine whether Lambda should process an event. For more information, see Lambda event filtering.
*/ FilterCriteria?: FilterCriteria; /** *The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
* You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default
* batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.
* To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
*/ ParallelizationFactor?: number; /** *The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon
* DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for
* Amazon Kinesis streams and Amazon DocumentDB.
With StartingPosition set to AT_TIMESTAMP, the time from which to start
* reading.
(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.
*/ DestinationConfig?: DestinationConfig; /** *(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
*/ MaximumRecordAgeInSeconds?: number; /** *(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
*/ BisectBatchOnFunctionError?: boolean; /** *(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
*/ MaximumRetryAttempts?: number; /** *(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
*/ TumblingWindowInSeconds?: number; /** *The name of the Kafka topic.
*/ Topics?: string[]; /** *(MQ) The name of the Amazon MQ broker destination queue to consume.
*/ Queues?: string[]; /** *An array of authentication protocols or VPC components required to secure your event source.
*/ SourceAccessConfigurations?: SourceAccessConfiguration[]; /** *The self-managed Apache Kafka cluster to receive records from.
*/ SelfManagedEventSource?: SelfManagedEventSource; /** *(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
*/ FunctionResponseTypes?: (FunctionResponseType | string)[]; /** *Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
*/ AmazonManagedKafkaEventSourceConfig?: AmazonManagedKafkaEventSourceConfig; /** *Specific configuration settings for a self-managed Apache Kafka event source.
*/ SelfManagedKafkaEventSourceConfig?: SelfManagedKafkaEventSourceConfig; /** *(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
*/ ScalingConfig?: ScalingConfig; /** *Specific configuration settings for a DocumentDB event source.
*/ DocumentDBEventSourceConfig?: DocumentDBEventSourceConfig; } /** * @public *A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.
*/ export interface EventSourceMappingConfiguration { /** *The identifier of the event source mapping.
*/ UUID?: string; /** *The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis
* streams and Amazon DocumentDB.
With StartingPosition set to AT_TIMESTAMP, the time from which to start
* reading.
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).
*Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
*Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
* You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default
* batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.
* To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
*/ ParallelizationFactor?: number; /** *The Amazon Resource Name (ARN) of the event source.
*/ EventSourceArn?: string; /** *An object that defines the filter criteria that * determine whether Lambda should process an event. For more information, see Lambda event filtering.
*/ FilterCriteria?: FilterCriteria; /** *The ARN of the Lambda function.
*/ FunctionArn?: string; /** *The date that the event source mapping was last updated or that its state changed.
*/ LastModified?: Date; /** *The result of the last Lambda invocation of your function.
*/ LastProcessingResult?: string; /** *The state of the event source mapping. It can be one of the following: Creating,
* Enabling, Enabled, Disabling, Disabled,
* Updating, or Deleting.
Indicates whether a user or Lambda made the last change to the event source mapping.
*/ StateTransitionReason?: string; /** *(Kinesis and DynamoDB Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
*/ DestinationConfig?: DestinationConfig; /** *The name of the Kafka topic.
*/ Topics?: string[]; /** *(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
*/ Queues?: string[]; /** *An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
*/ SourceAccessConfigurations?: SourceAccessConfiguration[]; /** *The self-managed Apache Kafka cluster for your event source.
*/ SelfManagedEventSource?: SelfManagedEventSource; /** *(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, * which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
*The minimum value that can be set is 60 seconds.
*(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
*/ BisectBatchOnFunctionError?: boolean; /** *(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, * which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
*/ MaximumRetryAttempts?: number; /** *(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
*/ TumblingWindowInSeconds?: number; /** *(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
*/ FunctionResponseTypes?: (FunctionResponseType | string)[]; /** *Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
*/ AmazonManagedKafkaEventSourceConfig?: AmazonManagedKafkaEventSourceConfig; /** *Specific configuration settings for a self-managed Apache Kafka event source.
*/ SelfManagedKafkaEventSourceConfig?: SelfManagedKafkaEventSourceConfig; /** *(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
*/ ScalingConfig?: ScalingConfig; /** *Specific configuration settings for a DocumentDB event source.
*/ DocumentDBEventSourceConfig?: DocumentDBEventSourceConfig; } /** * @public *The specified code signing configuration does not exist.
*/ export declare class CodeSigningConfigNotFoundException extends __BaseException { readonly name: "CodeSigningConfigNotFoundException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeYour Amazon Web Services account has exceeded its maximum total code size. For more information, see Lambda quotas.
*/ export declare class CodeStorageExceededException extends __BaseException { readonly name: "CodeStorageExceededException"; readonly $fault: "client"; /** *The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe code signature failed one or more of the validation checks for signature mismatch or expiry, and the code * signing policy is set to ENFORCE. Lambda blocks the deployment.
*/ export declare class CodeVerificationFailedException extends __BaseException { readonly name: "CodeVerificationFailedException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ export interface FunctionCode { /** *The base64-encoded contents of the deployment package. Amazon Web Services SDK and CLI clients handle the encoding for * you.
*/ ZipFile?: Uint8Array; /** *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.
*/ S3Bucket?: string; /** *The Amazon S3 key of the deployment package.
*/ S3Key?: string; /** *For versioned objects, the version of the deployment package object to use.
*/ S3ObjectVersion?: string; /** *URI of a container image in the * Amazon ECR registry.
*/ ImageUri?: string; } /** * @public *The dead-letter queue for * failed asynchronous invocations.
*/ export interface DeadLetterConfig { /** *The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
*/ TargetArn?: string; } /** * @public *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.
*/ export interface Environment { /** *Environment variable key-value pairs. For more information, see Using Lambda environment variables.
*/ Variables?: RecordThe 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.
The size of the function's /tmp directory.
Details about the connection between a Lambda function and an Amazon EFS file system.
*/ export interface FileSystemConfig { /** *The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file * system.
*/ Arn: string | undefined; /** *The path where the function can access the file system, starting with /mnt/.
Configuration values that override the container image Dockerfile settings. For more information, see Container image * settings.
*/ export interface ImageConfig { /** *Specifies the entry point to their application, which is typically the location of the runtime * executable.
*/ EntryPoint?: string[]; /** *Specifies parameters that you want to pass in with ENTRYPOINT.
*/ Command?: string[]; /** *Specifies the working directory.
*/ WorkingDirectory?: string; } /** * @public * @enum */ export declare const PackageType: { readonly Image: "Image"; readonly Zip: "Zip"; }; /** * @public */ export type PackageType = (typeof PackageType)[keyof typeof PackageType]; /** * @public * @enum */ export declare const Runtime: { readonly dotnet6: "dotnet6"; readonly dotnetcore10: "dotnetcore1.0"; readonly dotnetcore20: "dotnetcore2.0"; readonly dotnetcore21: "dotnetcore2.1"; readonly dotnetcore31: "dotnetcore3.1"; readonly go1x: "go1.x"; readonly java11: "java11"; readonly java17: "java17"; readonly java8: "java8"; readonly java8al2: "java8.al2"; readonly nodejs: "nodejs"; readonly nodejs10x: "nodejs10.x"; readonly nodejs12x: "nodejs12.x"; readonly nodejs14x: "nodejs14.x"; readonly nodejs16x: "nodejs16.x"; readonly nodejs18x: "nodejs18.x"; readonly nodejs43: "nodejs4.3"; readonly nodejs43edge: "nodejs4.3-edge"; readonly nodejs610: "nodejs6.10"; readonly nodejs810: "nodejs8.10"; readonly provided: "provided"; readonly providedal2: "provided.al2"; readonly python27: "python2.7"; readonly python310: "python3.10"; readonly python36: "python3.6"; readonly python37: "python3.7"; readonly python38: "python3.8"; readonly python39: "python3.9"; readonly ruby25: "ruby2.5"; readonly ruby27: "ruby2.7"; }; /** * @public */ export type Runtime = (typeof Runtime)[keyof typeof Runtime]; /** * @public * @enum */ export declare const SnapStartApplyOn: { readonly None: "None"; readonly PublishedVersions: "PublishedVersions"; }; /** * @public */ export type SnapStartApplyOn = (typeof SnapStartApplyOn)[keyof typeof SnapStartApplyOn]; /** * @public *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.
Set to PublishedVersions to create a snapshot of the initialized execution environment when you publish a function version.
The function's X-Ray tracing configuration.
* To sample and record incoming requests, set Mode to Active.
The tracing mode.
*/ Mode?: TracingMode | string; } /** * @public *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.
*/ export interface VpcConfig { /** *A list of VPC subnet IDs.
*/ SubnetIds?: string[]; /** *A list of VPC security group IDs.
*/ SecurityGroupIds?: string[]; } /** * @public */ export interface CreateFunctionRequest { /** *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.
*/ FunctionName: string | undefined; /** *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.
*/ Runtime?: Runtime | string; /** *The Amazon Resource Name (ARN) of the function's execution role.
*/ Role: string | undefined; /** *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.
*/ Handler?: string; /** *The code for the function.
*/ Code: FunctionCode | undefined; /** *A description of the function.
*/ Description?: string; /** *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.
*/ Timeout?: number; /** *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.
*/ MemorySize?: number; /** *Set to true to publish the first version of the function during creation.
*/ Publish?: boolean; /** *For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. * When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more * information, see Configuring a Lambda function to access resources in a VPC.
*/ VpcConfig?: VpcConfig; /** *The type of deployment package. Set to Image for container image and set to Zip for .zip file archive.
A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events * when they fail processing. For more information, see Dead-letter queues.
*/ DeadLetterConfig?: DeadLetterConfig; /** *Environment variables that are accessible from function code during execution.
*/ Environment?: Environment; /** *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.
*/ KMSKeyArn?: string; /** *Set Mode to Active to sample and trace a subset of incoming requests with
* X-Ray.
A list of tags to apply to the * function.
*/ Tags?: RecordA list of function layers * to add to the function's execution environment. Specify each layer by its ARN, including the version.
*/ Layers?: string[]; /** *Connection settings for an Amazon EFS file system.
*/ FileSystemConfigs?: FileSystemConfig[]; /** *Container image configuration * values that override the values in the container image Dockerfile.
*/ ImageConfig?: ImageConfig; /** *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.
*/ CodeSigningConfigArn?: string; /** *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.
The size of the function's /tmp directory in MB. The default value is 512, but can be any whole
* number between 512 and 10,240 MB.
The function's SnapStart setting.
*/ SnapStart?: SnapStart; } /** * @public *Error messages for environment variables that couldn't be applied.
*/ export interface EnvironmentError { /** *The error code.
*/ ErrorCode?: string; /** *The error message.
*/ Message?: string; } /** * @public *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.
*/ export interface EnvironmentResponse { /** *Environment variable key-value pairs. Omitted from CloudTrail logs.
*/ Variables?: RecordError messages for environment variables that couldn't be applied.
*/ Error?: EnvironmentError; } /** * @public *Error response to GetFunctionConfiguration.
Error code.
*/ ErrorCode?: string; /** *Error message.
*/ Message?: string; } /** * @public *Response to a GetFunctionConfiguration request.
Configuration values that override the container image Dockerfile.
*/ ImageConfig?: ImageConfig; /** *Error response to GetFunctionConfiguration.
An Lambda * layer.
*/ export interface Layer { /** *The Amazon Resource Name (ARN) of the function layer.
*/ Arn?: string; /** *The size of the layer archive in bytes.
*/ CodeSize?: number; /** *The Amazon Resource Name (ARN) for a signing profile version.
*/ SigningProfileVersionArn?: string; /** *The Amazon Resource Name (ARN) of a signing job.
*/ SigningJobArn?: string; } /** * @public *Any error returned when the runtime version information for the function could not be retrieved.
*/ export interface RuntimeVersionError { /** *The error code.
*/ ErrorCode?: string; /** *The error message.
*/ Message?: string; } /** * @public *The ARN of the runtime and any errors that occured.
*/ export interface RuntimeVersionConfig { /** *The ARN of the runtime version you want the function to use.
*/ RuntimeVersionArn?: string; /** *Error response when Lambda is unable to retrieve the runtime version for a function.
*/ Error?: RuntimeVersionError; } /** * @public * @enum */ export declare const SnapStartOptimizationStatus: { readonly Off: "Off"; readonly On: "On"; }; /** * @public */ export type SnapStartOptimizationStatus = (typeof SnapStartOptimizationStatus)[keyof typeof SnapStartOptimizationStatus]; /** * @public *The function's SnapStart setting.
*/ export interface SnapStartResponse { /** *When set to PublishedVersions, Lambda creates a snapshot of the execution environment when you publish a function version.
When you provide a qualified Amazon Resource Name (ARN), this response element indicates whether SnapStart is activated for the specified function version.
*/ OptimizationStatus?: SnapStartOptimizationStatus | string; } /** * @public * @enum */ export declare const State: { readonly Active: "Active"; readonly Failed: "Failed"; readonly Inactive: "Inactive"; readonly Pending: "Pending"; }; /** * @public */ export type State = (typeof State)[keyof typeof State]; /** * @public * @enum */ export declare const StateReasonCode: { readonly Creating: "Creating"; readonly DisabledKMSKey: "DisabledKMSKey"; readonly EFSIOError: "EFSIOError"; readonly EFSMountConnectivityError: "EFSMountConnectivityError"; readonly EFSMountFailure: "EFSMountFailure"; readonly EFSMountTimeout: "EFSMountTimeout"; readonly EniLimitExceeded: "EniLimitExceeded"; readonly FunctionError: "FunctionError"; readonly Idle: "Idle"; readonly ImageAccessDenied: "ImageAccessDenied"; readonly ImageDeleted: "ImageDeleted"; readonly InsufficientRolePermissions: "InsufficientRolePermissions"; readonly InternalError: "InternalError"; readonly InvalidConfiguration: "InvalidConfiguration"; readonly InvalidImage: "InvalidImage"; readonly InvalidRuntime: "InvalidRuntime"; readonly InvalidSecurityGroup: "InvalidSecurityGroup"; readonly InvalidStateKMSKey: "InvalidStateKMSKey"; readonly InvalidSubnet: "InvalidSubnet"; readonly InvalidZipFileException: "InvalidZipFileException"; readonly KMSKeyAccessDenied: "KMSKeyAccessDenied"; readonly KMSKeyNotFound: "KMSKeyNotFound"; readonly Restoring: "Restoring"; readonly SubnetOutOfIPAddresses: "SubnetOutOfIPAddresses"; }; /** * @public */ export type StateReasonCode = (typeof StateReasonCode)[keyof typeof StateReasonCode]; /** * @public *The function's X-Ray tracing configuration.
*/ export interface TracingConfigResponse { /** *The tracing mode.
*/ Mode?: TracingMode | string; } /** * @public *The VPC security groups and subnets that are attached to a Lambda function.
*/ export interface VpcConfigResponse { /** *A list of VPC subnet IDs.
*/ SubnetIds?: string[]; /** *A list of VPC security group IDs.
*/ SecurityGroupIds?: string[]; /** *The ID of the VPC.
*/ VpcId?: string; } /** * @public *Details about a function's configuration.
*/ export interface FunctionConfiguration { /** *The name of the function.
*/ FunctionName?: string; /** *The function's Amazon Resource Name (ARN).
*/ FunctionArn?: string; /** *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.
*/ Runtime?: Runtime | string; /** *The function's execution role.
*/ Role?: string; /** *The function that Lambda calls to begin running your function.
*/ Handler?: string; /** *The size of the function's deployment package, in bytes.
*/ CodeSize?: number; /** *The function's description.
*/ Description?: string; /** *The amount of time in seconds that Lambda allows a function to run before stopping it.
*/ Timeout?: number; /** *The amount of memory available to the function at runtime.
*/ MemorySize?: number; /** *The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ LastModified?: string; /** *The SHA256 hash of the function's deployment package.
*/ CodeSha256?: string; /** *The version of the Lambda function.
*/ Version?: string; /** *The function's networking configuration.
*/ VpcConfig?: VpcConfigResponse; /** *The function's dead letter queue.
*/ DeadLetterConfig?: DeadLetterConfig; /** *The function's environment variables. Omitted from CloudTrail logs.
*/ Environment?: EnvironmentResponse; /** *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.
*/ KMSKeyArn?: string; /** *The function's X-Ray tracing configuration.
*/ TracingConfig?: TracingConfigResponse; /** *For Lambda@Edge functions, the ARN of the main function.
*/ MasterArn?: string; /** *The latest updated revision of the function or alias.
*/ RevisionId?: string; /** *The function's layers.
*/ Layers?: Layer[]; /** *The current state of the function. When the state is Inactive, you can reactivate the function by
* invoking it.
The reason for the function's current state.
*/ StateReason?: string; /** *The reason code for the function's current state. When the code is Creating, you can't invoke or
* modify the function.
The status of the last update that was performed on the function. This is first set to Successful
* after function creation completes.
The reason for the last update that was performed on the function.
*/ LastUpdateStatusReason?: string; /** *The reason code for the last update that was performed on the function.
*/ LastUpdateStatusReasonCode?: LastUpdateStatusReasonCode | string; /** *Connection settings for an Amazon EFS file system.
*/ FileSystemConfigs?: FileSystemConfig[]; /** *The type of deployment package. Set to Image for container image and set Zip for .zip file archive.
The function's image configuration values.
*/ ImageConfigResponse?: ImageConfigResponse; /** *The ARN of the signing profile version.
*/ SigningProfileVersionArn?: string; /** *The ARN of the signing job.
*/ SigningJobArn?: string; /** *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.
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.
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.
The ARN of the runtime and any errors that occured.
*/ RuntimeVersionConfig?: RuntimeVersionConfig; } /** * @public *The code signature failed the integrity check. If the integrity check fails, then Lambda blocks * deployment, even if the code signing policy is set to WARN.
*/ export declare class InvalidCodeSignatureException extends __BaseException { readonly name: "InvalidCodeSignatureException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ export interface Cors { /** *Whether to allow cookies or other credentials in requests to your function URL. The default is
* false.
The HTTP headers that origins can include in requests to your function URL. For example: Date, Keep-Alive,
* X-Custom-Header.
The HTTP methods that are allowed when calling your function URL. For example: GET, POST, DELETE,
* or the wildcard character (*).
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 (*).
The HTTP headers in your function response that you want to expose to origins that call your function URL. For example:
* Date, Keep-Alive, X-Custom-Header.
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.
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.
*/ FunctionName: string | undefined; /** *The alias name.
*/ Qualifier?: string; /** *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.
The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *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 HTTP URL endpoint for your function.
*/ FunctionUrl: string | undefined; /** *The Amazon Resource Name (ARN) of your function.
*/ FunctionArn: string | undefined; /** *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.
The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreationTime: string | undefined; /** *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.
*/ FunctionName: string | undefined; /** *The name of the alias.
*/ Name: string | undefined; } /** * @public */ export interface DeleteCodeSigningConfigRequest { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; } /** * @public */ export interface DeleteCodeSigningConfigResponse { } /** * @public */ export interface DeleteEventSourceMappingRequest { /** *The identifier of the event source mapping.
*/ UUID: string | undefined; } /** * @public *The operation conflicts with the resource's availability. For example, you tried to update an event source * mapping in the CREATING state, or you tried to delete an event source mapping currently UPDATING.
*/ export declare class ResourceInUseException extends __BaseException { readonly name: "ResourceInUseException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ FunctionName: string | undefined; /** *Specify a version to delete. You can't delete a version that an alias references.
*/ Qualifier?: string; } /** * @public */ export interface DeleteFunctionCodeSigningConfigRequest { /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface DeleteFunctionConcurrencyRequest { /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface DeleteFunctionEventInvokeConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *A version number or alias name.
*/ Qualifier?: string; } /** * @public */ export interface DeleteFunctionUrlConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *The alias name.
*/ Qualifier?: string; } /** * @public */ export interface DeleteLayerVersionRequest { /** *The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The version number.
*/ VersionNumber: number | undefined; } /** * @public */ export interface DeleteProvisionedConcurrencyConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *The version number or alias name.
*/ Qualifier: string | undefined; } /** * @public */ export interface GetAccountSettingsRequest { } /** * @public */ export interface GetAccountSettingsResponse { /** *Limits that are related to concurrency and code storage.
*/ AccountLimit?: AccountLimit; /** *The number of functions and amount of storage in use.
*/ AccountUsage?: AccountUsage; } /** * @public */ export interface GetAliasRequest { /** *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.
*/ FunctionName: string | undefined; /** *The name of the alias.
*/ Name: string | undefined; } /** * @public */ export interface GetCodeSigningConfigRequest { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; } /** * @public */ export interface GetCodeSigningConfigResponse { /** *The code signing configuration
*/ CodeSigningConfig: CodeSigningConfig | undefined; } /** * @public */ export interface GetEventSourceMappingRequest { /** *The identifier of the event source mapping.
*/ UUID: string | undefined; } /** * @public */ export interface GetFunctionRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify a version or alias to get details about a published version of the function.
*/ Qualifier?: string; } /** * @public *Details about a function's deployment package.
*/ export interface FunctionCodeLocation { /** *The service that's hosting the file.
*/ RepositoryType?: string; /** *A presigned URL that you can use to download the deployment package.
*/ Location?: string; /** *URI of a container image in the Amazon ECR registry.
*/ ImageUri?: string; /** *The resolved URI for the image.
*/ ResolvedImageUri?: string; } /** * @public */ export interface Concurrency { /** *The number of concurrent executions that are reserved for this function. For more information, see Managing Lambda reserved * concurrency.
*/ ReservedConcurrentExecutions?: number; } /** * @public */ export interface GetFunctionResponse { /** *The configuration of the function or version.
*/ Configuration?: FunctionConfiguration; /** *The deployment package of the function or version.
*/ Code?: FunctionCodeLocation; /** *The function's tags.
*/ Tags?: RecordThe function's reserved * concurrency.
*/ Concurrency?: Concurrency; } /** * @public */ export interface GetFunctionCodeSigningConfigRequest { /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface GetFunctionCodeSigningConfigResponse { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface GetFunctionConcurrencyRequest { /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface GetFunctionConcurrencyResponse { /** *The number of simultaneous executions that are reserved for the function.
*/ ReservedConcurrentExecutions?: number; } /** * @public */ export interface GetFunctionConfigurationRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify a version or alias to get details about a published version of the function.
*/ Qualifier?: string; } /** * @public */ export interface FunctionEventInvokeConfig { /** *The date and time that the configuration was last updated.
*/ LastModified?: Date; /** *The Amazon Resource Name (ARN) of the function.
*/ FunctionArn?: string; /** *The maximum number of times to retry when the function returns an error.
*/ MaximumRetryAttempts?: number; /** *The maximum age of a request that Lambda sends to a function for processing.
*/ MaximumEventAgeInSeconds?: number; /** *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.
*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.
*/ FunctionName: string | undefined; /** *A version number or alias name.
*/ Qualifier?: string; } /** * @public */ export interface GetFunctionUrlConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *The alias name.
*/ Qualifier?: string; } /** * @public */ export interface GetFunctionUrlConfigResponse { /** *The HTTP URL endpoint for your function.
*/ FunctionUrl: string | undefined; /** *The Amazon Resource Name (ARN) of your function.
*/ FunctionArn: string | undefined; /** *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.
The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreationTime: string | undefined; /** *When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ LastModifiedTime: string | undefined; /** *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 or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The version number.
*/ VersionNumber: number | undefined; } /** * @public *Details about a version of an Lambda * layer.
*/ export interface LayerVersionContentOutput { /** *A link to the layer archive in Amazon S3 that is valid for 10 minutes.
*/ Location?: string; /** *The SHA-256 hash of the layer archive.
*/ CodeSha256?: string; /** *The size of the layer archive in bytes.
*/ CodeSize?: number; /** *The Amazon Resource Name (ARN) for a signing profile version.
*/ SigningProfileVersionArn?: string; /** *The Amazon Resource Name (ARN) of a signing job.
*/ SigningJobArn?: string; } /** * @public */ export interface GetLayerVersionResponse { /** *Details about the layer version.
*/ Content?: LayerVersionContentOutput; /** *The ARN of the layer.
*/ LayerArn?: string; /** *The ARN of the layer version.
*/ LayerVersionArn?: string; /** *The description of the version.
*/ Description?: string; /** *The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreatedDate?: string; /** *The version number.
*/ Version?: number; /** *The layer's compatible runtimes.
*/ CompatibleRuntimes?: (Runtime | string)[]; /** *The layer's software license.
*/ LicenseInfo?: string; /** *A list of compatible * instruction set architectures.
*/ CompatibleArchitectures?: (Architecture | string)[]; } /** * @public */ export interface GetLayerVersionByArnRequest { /** *The ARN of the layer version.
*/ Arn: string | undefined; } /** * @public */ export interface GetLayerVersionPolicyRequest { /** *The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The version number.
*/ VersionNumber: number | undefined; } /** * @public */ export interface GetLayerVersionPolicyResponse { /** *The policy document.
*/ Policy?: string; /** *A unique identifier for the current revision of the policy.
*/ RevisionId?: string; } /** * @public */ export interface GetPolicyRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify a version or alias to get the policy for that resource.
*/ Qualifier?: string; } /** * @public */ export interface GetPolicyResponse { /** *The resource-based policy.
*/ Policy?: string; /** *A unique identifier for the current revision of the policy.
*/ RevisionId?: string; } /** * @public */ export interface GetProvisionedConcurrencyConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *The version number or alias name.
*/ Qualifier: string | undefined; } /** * @public * @enum */ export declare const ProvisionedConcurrencyStatusEnum: { readonly FAILED: "FAILED"; readonly IN_PROGRESS: "IN_PROGRESS"; readonly READY: "READY"; }; /** * @public */ export type ProvisionedConcurrencyStatusEnum = (typeof ProvisionedConcurrencyStatusEnum)[keyof typeof ProvisionedConcurrencyStatusEnum]; /** * @public */ export interface GetProvisionedConcurrencyConfigResponse { /** *The amount of provisioned concurrency requested.
*/ RequestedProvisionedConcurrentExecutions?: number; /** *The amount of provisioned concurrency available.
*/ AvailableProvisionedConcurrentExecutions?: number; /** *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.
*/ AllocatedProvisionedConcurrentExecutions?: number; /** *The status of the allocation process.
*/ Status?: ProvisionedConcurrencyStatusEnum | string; /** *For failed allocations, the reason that provisioned concurrency could not be allocated.
*/ StatusReason?: string; /** *The date and time that a user last updated the configuration, in ISO 8601 format.
*/ LastModified?: string; } /** * @public *The specified configuration does not exist.
*/ export declare class ProvisionedConcurrencyConfigNotFoundException extends __BaseException { readonly name: "ProvisionedConcurrencyConfigNotFoundException"; readonly $fault: "client"; Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ FunctionName: string | undefined; /** *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.
The current runtime update mode of the function.
*/ UpdateRuntimeOn?: UpdateRuntimeOn | string; /** *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.
The Amazon Resource Name (ARN) of your function.
*/ FunctionArn?: string; } /** * @public *Need additional permissions to configure VPC settings.
*/ export declare class EC2AccessDeniedException extends __BaseException { readonly name: "EC2AccessDeniedException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeAmazon EC2 throttled Lambda during Lambda function initialization using * the execution role provided for the function.
*/ export declare class EC2ThrottledException extends __BaseException { readonly name: "EC2ThrottledException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda received an unexpected Amazon EC2 client exception while setting up for the * Lambda function.
*/ export declare class EC2UnexpectedException extends __BaseException { readonly name: "EC2UnexpectedException"; readonly $fault: "server"; Type?: string; Message?: string; EC2ErrorCode?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeAn error occurred when reading from or writing to a connected file system.
*/ export declare class EFSIOException extends __BaseException { readonly name: "EFSIOException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe Lambda function couldn't make a network connection to the configured file system.
*/ export declare class EFSMountConnectivityException extends __BaseException { readonly name: "EFSMountConnectivityException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe Lambda function couldn't mount the configured file system due to a permission or configuration * issue.
*/ export declare class EFSMountFailureException extends __BaseException { readonly name: "EFSMountFailureException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe Lambda function made a network connection to the configured file system, but the mount * operation timed out.
*/ export declare class EFSMountTimeoutException extends __BaseException { readonly name: "EFSMountTimeoutException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda couldn't create an elastic network interface in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached. For more * information, see Lambda * quotas.
*/ export declare class ENILimitReachedException extends __BaseException { readonly name: "ENILimitReachedException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe request body could not be parsed as JSON.
*/ export declare class InvalidRequestContentException extends __BaseException { readonly name: "InvalidRequestContentException"; readonly $fault: "client"; /** *The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe runtime or runtime version specified is not supported.
*/ export declare class InvalidRuntimeException extends __BaseException { readonly name: "InvalidRuntimeException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe security group ID provided in the Lambda function VPC configuration is not valid.
*/ export declare class InvalidSecurityGroupIDException extends __BaseException { readonly name: "InvalidSecurityGroupIDException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe subnet ID provided in the Lambda function VPC configuration is not valid.
*/ export declare class InvalidSubnetIDException extends __BaseException { readonly name: "InvalidSubnetIDException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda could not unzip the deployment package.
*/ export declare class InvalidZipFileException extends __BaseException { readonly name: "InvalidZipFileException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe 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.
*/ FunctionName: string | undefined; /** *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.
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context * object.
*/ ClientContext?: string; /** *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.
Specify a version or alias to invoke a published version of the function.
*/ Qualifier?: string; } /** * @public */ export interface InvocationResponse { /** *The HTTP status code is in the 200 range for a successful request. For the RequestResponse
* invocation type, this status code is 200. For the Event invocation type, this status code is 202. For
* the DryRun invocation type, the status code is 204.
If present, indicates that an error occurred during function execution. Details about the error are included * in the response payload.
*/ FunctionError?: string; /** *The last 4 KB of the execution log, which is base64-encoded.
*/ LogResult?: string; /** *The response from the function, or an error object.
*/ Payload?: Uint8Array; /** *The version of the function that executed. When you invoke a function with an alias, this indicates which * version the alias resolved to.
*/ ExecutedVersion?: string; } /** * @public *Lambda couldn't decrypt the environment variables because KMS access was denied. * Check the Lambda function's KMS permissions.
*/ export declare class KMSAccessDeniedException extends __BaseException { readonly name: "KMSAccessDeniedException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda couldn't decrypt the environment variables because the KMS key used is * disabled. Check the Lambda function's KMS key settings.
*/ export declare class KMSDisabledException extends __BaseException { readonly name: "KMSDisabledException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda couldn't decrypt the environment variables because the state of the KMS key used is not valid for Decrypt. Check the function's KMS key settings.
*/ export declare class KMSInvalidStateException extends __BaseException { readonly name: "KMSInvalidStateException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda couldn't decrypt the environment variables because the KMS key was not * found. Check the function's KMS key settings.
*/ export declare class KMSNotFoundException extends __BaseException { readonly name: "KMSNotFoundException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe request payload exceeded the Invoke request body JSON input quota. For more information, see Lambda
* quotas.
The function is inactive and its VPC connection is no longer available. Wait for the VPC connection to * reestablish and try again.
*/ export declare class ResourceNotReadyException extends __BaseException { readonly name: "ResourceNotReadyException"; readonly $fault: "server"; /** *The exception type.
*/ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe afterRestore()
* runtime hook encountered an error. For more information, check the Amazon CloudWatch logs.
Lambda is initializing your function. You can invoke the function when the function state becomes Active.
Lambda couldn't restore the snapshot within the timeout limit.
*/ export declare class SnapStartTimeoutException extends __BaseException { readonly name: "SnapStartTimeoutException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeLambda couldn't set up VPC access for the Lambda function because one or more * configured subnets has no available IP addresses.
*/ export declare class SubnetIPAddressLimitReachedException extends __BaseException { readonly name: "SubnetIPAddressLimitReachedException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe content type of the Invoke request body is not 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.
*/ FunctionName: string | undefined; /** *The JSON that you want to provide to your Lambda function as input.
*/ InvokeArgs: Readable | ReadableStream | Blob | undefined; } /** * @public * @deprecated * *A success response (202 Accepted) indicates that the request is queued for invocation.
The status code.
*/ Status?: number; } /** * @public * @enum */ export declare const ResponseStreamingInvocationType: { readonly DryRun: "DryRun"; readonly RequestResponse: "RequestResponse"; }; /** * @public */ export type ResponseStreamingInvocationType = (typeof ResponseStreamingInvocationType)[keyof typeof ResponseStreamingInvocationType]; /** * @public */ export interface InvokeWithResponseStreamRequest { /** *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.
*/ FunctionName: string | undefined; /** *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.
Set to Tail to include the execution log in the response. Applies to synchronously invoked functions only.
Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context * object.
*/ ClientContext?: string; /** *The alias name.
*/ Qualifier?: string; /** *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.
A response confirming that the event stream is complete.
*/ export interface InvokeWithResponseStreamCompleteEvent { /** *An error code.
*/ ErrorCode?: string; /** *The details of any returned error.
*/ ErrorDetails?: string; /** *The last 4 KB of the execution log, which is base64-encoded.
*/ LogResult?: string; } /** * @public *A chunk of the streamed response payload.
*/ export interface InvokeResponseStreamUpdate { /** *Data returned by your Lambda function.
*/ Payload?: Uint8Array; } /** * @public *An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.
A chunk of the streamed response payload.
*/ interface PayloadChunkMember { PayloadChunk: InvokeResponseStreamUpdate; InvokeComplete?: never; $unknown?: never; } /** *An object that's returned when the stream has ended and all the payload chunks have been * returned.
*/ interface InvokeCompleteMember { PayloadChunk?: never; InvokeComplete: InvokeWithResponseStreamCompleteEvent; $unknown?: never; } interface $UnknownMember { PayloadChunk?: never; InvokeComplete?: never; $unknown: [string, any]; } interface VisitorFor 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.
The version of the function that executed. When you invoke a function with an alias, this * indicates which version the alias resolved to.
*/ ExecutedVersion?: string; /** *The stream of response payloads.
*/ EventStream?: AsyncIterableThe type of data the stream is returning.
*/ ResponseStreamContentType?: string; } /** * @public */ export interface ListAliasesRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify a function version to only list aliases that invoke that version.
*/ FunctionVersion?: string; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *Limit the number of aliases returned.
*/ MaxItems?: number; } /** * @public */ export interface ListAliasesResponse { /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; /** *A list of aliases.
*/ Aliases?: AliasConfiguration[]; } /** * @public */ export interface ListCodeSigningConfigsRequest { /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *Maximum number of items to return.
*/ MaxItems?: number; } /** * @public */ export interface ListCodeSigningConfigsResponse { /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; /** *The code signing configurations
*/ CodeSigningConfigs?: CodeSigningConfig[]; } /** * @public */ export interface ListEventSourceMappingsRequest { /** *The Amazon Resource Name (ARN) of the event source.
** Amazon Kinesis – The ARN of the data stream or a stream consumer.
** Amazon DynamoDB Streams – The ARN of the stream.
** Amazon Simple Queue Service – The ARN of the queue.
** Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.
** Amazon MQ – The ARN of the broker.
** Amazon DocumentDB – The ARN of the DocumentDB change stream.
*The name of the Lambda function.
** Name formats *
*
* Function name – MyFunction.
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
* Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
* Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 * characters in length.
*/ FunctionName?: string; /** *A pagination token returned by a previous call.
*/ Marker?: string; /** *The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of * 100 items in each response, even if you set the number higher.
*/ MaxItems?: number; } /** * @public */ export interface ListEventSourceMappingsResponse { /** *A pagination token that's returned when the response doesn't contain all event source mappings.
*/ NextMarker?: string; /** *A list of event source mappings.
*/ EventSourceMappings?: EventSourceMappingConfiguration[]; } /** * @public */ export interface ListFunctionEventInvokeConfigsRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *The maximum number of configurations to return.
*/ MaxItems?: number; } /** * @public */ export interface ListFunctionEventInvokeConfigsResponse { /** *A list of configurations.
*/ FunctionEventInvokeConfigs?: FunctionEventInvokeConfig[]; /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; } /** * @public * @enum */ export declare const FunctionVersion: { readonly ALL: "ALL"; }; /** * @public */ export type FunctionVersion = (typeof FunctionVersion)[keyof typeof FunctionVersion]; /** * @public */ export interface ListFunctionsRequest { /** *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.
Set to ALL to include entries for all published versions of each function.
Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *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.
A list of Lambda functions.
*/ export interface ListFunctionsResponse { /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; /** *A list of Lambda functions.
*/ Functions?: FunctionConfiguration[]; } /** * @public */ export interface ListFunctionsByCodeSigningConfigRequest { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *Maximum number of items to return.
*/ MaxItems?: number; } /** * @public */ export interface ListFunctionsByCodeSigningConfigResponse { /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; /** *The function ARNs.
*/ FunctionArns?: string[]; } /** * @public */ export interface ListFunctionUrlConfigsRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *The maximum number of function URLs to return in the response. Note that ListFunctionUrlConfigs
* returns a maximum of 50 items in each response, even if you set the number higher.
Details about a Lambda function URL.
*/ export interface FunctionUrlConfig { /** *The HTTP URL endpoint for your function.
*/ FunctionUrl: string | undefined; /** *The Amazon Resource Name (ARN) of your function.
*/ FunctionArn: string | undefined; /** *When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreationTime: string | undefined; /** *When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ LastModifiedTime: string | undefined; /** *The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *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.
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.
A list of function URL configurations.
*/ FunctionUrlConfigs: FunctionUrlConfig[] | undefined; /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; } /** * @public */ export interface ListLayersRequest { /** *A runtime identifier. For example, go1.x.
A pagination token returned by a previous call.
*/ Marker?: string; /** *The maximum number of layers to return.
*/ MaxItems?: number; /** *The compatible * instruction set architecture.
*/ CompatibleArchitecture?: Architecture | string; } /** * @public *Details about a version of an Lambda * layer.
*/ export interface LayerVersionsListItem { /** *The ARN of the layer version.
*/ LayerVersionArn?: string; /** *The version number.
*/ Version?: number; /** *The description of the version.
*/ Description?: string; /** *The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.
The layer's compatible runtimes.
*/ CompatibleRuntimes?: (Runtime | string)[]; /** *The layer's open-source license.
*/ LicenseInfo?: string; /** *A list of compatible * instruction set architectures.
*/ CompatibleArchitectures?: (Architecture | string)[]; } /** * @public *Details about an Lambda * layer.
*/ export interface LayersListItem { /** *The name of the layer.
*/ LayerName?: string; /** *The Amazon Resource Name (ARN) of the function layer.
*/ LayerArn?: string; /** *The newest version of the layer.
*/ LatestMatchingVersion?: LayerVersionsListItem; } /** * @public */ export interface ListLayersResponse { /** *A pagination token returned when the response doesn't contain all layers.
*/ NextMarker?: string; /** *A list of function layers.
*/ Layers?: LayersListItem[]; } /** * @public */ export interface ListLayerVersionsRequest { /** *A runtime identifier. For example, go1.x.
The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *A pagination token returned by a previous call.
*/ Marker?: string; /** *The maximum number of versions to return.
*/ MaxItems?: number; /** *The compatible * instruction set architecture.
*/ CompatibleArchitecture?: Architecture | string; } /** * @public */ export interface ListLayerVersionsResponse { /** *A pagination token returned when the response doesn't contain all versions.
*/ NextMarker?: string; /** *A list of versions.
*/ LayerVersions?: LayerVersionsListItem[]; } /** * @public */ export interface ListProvisionedConcurrencyConfigsRequest { /** *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.
*/ FunctionName: string | undefined; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *Specify a number to limit the number of configurations returned.
*/ MaxItems?: number; } /** * @public *Details about the provisioned concurrency configuration for a function alias or version.
*/ export interface ProvisionedConcurrencyConfigListItem { /** *The Amazon Resource Name (ARN) of the alias or version.
*/ FunctionArn?: string; /** *The amount of provisioned concurrency requested.
*/ RequestedProvisionedConcurrentExecutions?: number; /** *The amount of provisioned concurrency available.
*/ AvailableProvisionedConcurrentExecutions?: number; /** *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.
*/ AllocatedProvisionedConcurrentExecutions?: number; /** *The status of the allocation process.
*/ Status?: ProvisionedConcurrencyStatusEnum | string; /** *For failed allocations, the reason that provisioned concurrency could not be allocated.
*/ StatusReason?: string; /** *The date and time that a user last updated the configuration, in ISO 8601 format.
*/ LastModified?: string; } /** * @public */ export interface ListProvisionedConcurrencyConfigsResponse { /** *A list of provisioned concurrency configurations.
*/ ProvisionedConcurrencyConfigs?: ProvisionedConcurrencyConfigListItem[]; /** *The pagination token that's included if more results are available.
*/ NextMarker?: string; } /** * @public */ export interface ListTagsRequest { /** *The function's Amazon Resource Name (ARN). * Note: Lambda does not support adding tags to aliases or versions.
*/ Resource: string | undefined; } /** * @public */ export interface ListTagsResponse { /** *The function's tags.
*/ Tags?: RecordThe 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.
*/ FunctionName: string | undefined; /** *Specify the pagination token that's returned by a previous request to retrieve the next page of results.
*/ Marker?: string; /** *The maximum number of versions to return. Note that ListVersionsByFunction returns a maximum of 50 items in each response,
* even if you set the number higher.
The pagination token that's included if more results are available.
*/ NextMarker?: string; /** *A list of Lambda function versions.
*/ Versions?: FunctionConfiguration[]; } /** * @public *A ZIP archive that contains the contents of an Lambda * layer. You can specify either an Amazon S3 location, * or upload a layer archive directly.
*/ export interface LayerVersionContentInput { /** *The Amazon S3 bucket of the layer archive.
*/ S3Bucket?: string; /** *The Amazon S3 key of the layer archive.
*/ S3Key?: string; /** *For versioned objects, the version of the layer archive object to use.
*/ S3ObjectVersion?: string; /** *The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for * you.
*/ ZipFile?: Uint8Array; } /** * @public */ export interface PublishLayerVersionRequest { /** *The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The description of the version.
*/ Description?: string; /** *The function layer archive.
*/ Content: LayerVersionContentInput | undefined; /** *A list of compatible function * runtimes. Used for filtering with ListLayers and ListLayerVersions.
*/ CompatibleRuntimes?: (Runtime | string)[]; /** *The layer's software license. It can be any of the following:
*An SPDX license identifier. For example,
* MIT.
The URL of a license hosted on the internet. For example,
* https://opensource.org/licenses/MIT.
The full text of the license.
*A list of compatible * instruction set architectures.
*/ CompatibleArchitectures?: (Architecture | string)[]; } /** * @public */ export interface PublishLayerVersionResponse { /** *Details about the layer version.
*/ Content?: LayerVersionContentOutput; /** *The ARN of the layer.
*/ LayerArn?: string; /** *The ARN of the layer version.
*/ LayerVersionArn?: string; /** *The description of the version.
*/ Description?: string; /** *The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreatedDate?: string; /** *The version number.
*/ Version?: number; /** *The layer's compatible runtimes.
*/ CompatibleRuntimes?: (Runtime | string)[]; /** *The layer's software license.
*/ LicenseInfo?: string; /** *A list of compatible * instruction set architectures.
*/ CompatibleArchitectures?: (Architecture | string)[]; } /** * @public */ export interface PublishVersionRequest { /** *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.
*/ FunctionName: string | undefined; /** *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.
*/ CodeSha256?: string; /** *A description for the version to override the description in the function configuration.
*/ Description?: string; /** *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.
*/ RevisionId?: string; } /** * @public */ export interface PutFunctionCodeSigningConfigRequest { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface PutFunctionCodeSigningConfigResponse { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *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.
*/ FunctionName: string | undefined; } /** * @public */ export interface PutFunctionConcurrencyRequest { /** *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.
*/ FunctionName: string | undefined; /** *The number of simultaneous executions to reserve for the function.
*/ ReservedConcurrentExecutions: number | undefined; } /** * @public */ export interface PutFunctionEventInvokeConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *A version number or alias name.
*/ Qualifier?: string; /** *The maximum number of times to retry when the function returns an error.
*/ MaximumRetryAttempts?: number; /** *The maximum age of a request that Lambda sends to a function for processing.
*/ MaximumEventAgeInSeconds?: number; /** *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.
*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.
*/ FunctionName: string | undefined; /** *The version number or alias name.
*/ Qualifier: string | undefined; /** *The amount of provisioned concurrency to allocate for the version or alias.
*/ ProvisionedConcurrentExecutions: number | undefined; } /** * @public */ export interface PutProvisionedConcurrencyConfigResponse { /** *The amount of provisioned concurrency requested.
*/ RequestedProvisionedConcurrentExecutions?: number; /** *The amount of provisioned concurrency available.
*/ AvailableProvisionedConcurrentExecutions?: number; /** *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.
*/ AllocatedProvisionedConcurrentExecutions?: number; /** *The status of the allocation process.
*/ Status?: ProvisionedConcurrencyStatusEnum | string; /** *For failed allocations, the reason that provisioned concurrency could not be allocated.
*/ StatusReason?: string; /** *The date and time that a user last updated the configuration, in ISO 8601 format.
*/ LastModified?: string; } /** * @public */ export interface PutRuntimeManagementConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *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.
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 runtime update mode.
*/ UpdateRuntimeOn: UpdateRuntimeOn | string | undefined; /** *The ARN of the function
*/ FunctionArn: string | undefined; /** *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.
The name or Amazon Resource Name (ARN) of the layer.
*/ LayerName: string | undefined; /** *The version number.
*/ VersionNumber: number | undefined; /** *The identifier that was specified when the statement was added.
*/ StatementId: string | undefined; /** *Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a * policy that has changed since you last read it.
*/ RevisionId?: string; } /** * @public */ export interface RemovePermissionRequest { /** *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.
*/ FunctionName: string | undefined; /** *Statement ID of the permission to remove.
*/ StatementId: string | undefined; /** *Specify a version or alias to remove permissions from a published version of the function.
*/ Qualifier?: string; /** *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.
*/ RevisionId?: string; } /** * @public */ export interface TagResourceRequest { /** *The function's Amazon Resource Name (ARN).
*/ Resource: string | undefined; /** *A list of tags to apply to the function.
*/ Tags: RecordThe function's Amazon Resource Name (ARN).
*/ Resource: string | undefined; /** *A list of tag keys to remove from the function.
*/ TagKeys: string[] | undefined; } /** * @public */ export interface UpdateAliasRequest { /** *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.
*/ FunctionName: string | undefined; /** *The name of the alias.
*/ Name: string | undefined; /** *The function version that the alias invokes.
*/ FunctionVersion?: string; /** *A description of the alias.
*/ Description?: string; /** *The routing * configuration of the alias.
*/ RoutingConfig?: AliasRoutingConfiguration; /** *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.
*/ RevisionId?: string; } /** * @public */ export interface UpdateCodeSigningConfigRequest { /** *The The Amazon Resource Name (ARN) of the code signing configuration.
*/ CodeSigningConfigArn: string | undefined; /** *Descriptive name for this code signing configuration.
*/ Description?: string; /** *Signing profiles for this code signing configuration.
*/ AllowedPublishers?: AllowedPublishers; /** *The code signing policy.
*/ CodeSigningPolicies?: CodeSigningPolicies; } /** * @public */ export interface UpdateCodeSigningConfigResponse { /** *The code signing configuration
*/ CodeSigningConfig: CodeSigningConfig | undefined; } /** * @public */ export interface UpdateEventSourceMappingRequest { /** *The identifier of the event source mapping.
*/ UUID: string | undefined; /** *The name of the Lambda function.
** Name formats *
*
* Function name – MyFunction.
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
* Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
* Partial ARN – 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 * characters in length.
*/ FunctionName?: string; /** *When true, the event source mapping is active. When false, Lambda pauses polling and invocation.
*Default: True
*/ Enabled?: boolean; /** *The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation * (6 MB).
** Amazon Kinesis – Default 100. Max 10,000.
** Amazon DynamoDB Streams – Default 100. Max 10,000.
** Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.
** Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.
** Self-managed Apache Kafka – Default 100. Max 10,000.
** Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.
** DocumentDB – Default 100. Max 10,000.
*An object that defines the filter criteria that * determine whether Lambda should process an event. For more information, see Lambda event filtering.
*/ FilterCriteria?: FilterCriteria; /** *The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
* You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.
For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default
* batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it.
* To restore the default batching window, you must create a new event source mapping.
Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.
(Kinesis and DynamoDB Streams only) A standard Amazon SQS queue or standard Amazon SNS topic destination for discarded records.
*/ DestinationConfig?: DestinationConfig; /** *(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
*/ MaximumRecordAgeInSeconds?: number; /** *(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
*/ BisectBatchOnFunctionError?: boolean; /** *(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
*/ MaximumRetryAttempts?: number; /** *(Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
*/ ParallelizationFactor?: number; /** *An array of authentication protocols or VPC components required to secure your event source.
*/ SourceAccessConfigurations?: SourceAccessConfiguration[]; /** *(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
*/ TumblingWindowInSeconds?: number; /** *(Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
*/ FunctionResponseTypes?: (FunctionResponseType | string)[]; /** *(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
*/ ScalingConfig?: ScalingConfig; /** *Specific configuration settings for a DocumentDB event source.
*/ DocumentDBEventSourceConfig?: DocumentDBEventSourceConfig; } /** * @public */ export interface UpdateFunctionCodeRequest { /** *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.
*/ FunctionName: string | undefined; /** *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.
*/ ZipFile?: Uint8Array; /** *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.
*/ S3Bucket?: string; /** *The Amazon S3 key of the deployment package. Use only with a function defined with a .zip file archive deployment package.
*/ S3Key?: string; /** *For versioned objects, the version of the deployment package object to use.
*/ S3ObjectVersion?: string; /** *URI of a container image in the Amazon ECR registry. Do not use for a function defined with a .zip * file archive.
*/ ImageUri?: string; /** *Set to true to publish a new version of the function after updating the code. This has the same effect as * calling PublishVersion separately.
*/ Publish?: boolean; /** *Set to true to validate the request parameters and access permissions without modifying the function * code.
*/ DryRun?: boolean; /** *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.
*/ RevisionId?: string; /** *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.
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.
*/ FunctionName: string | undefined; /** *The Amazon Resource Name (ARN) of the function's execution role.
*/ Role?: string; /** *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.
*/ Handler?: string; /** *A description of the function.
*/ Description?: string; /** *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.
*/ Timeout?: number; /** *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.
*/ MemorySize?: number; /** *For network connectivity to Amazon Web Services resources in a VPC, specify a list of security groups and subnets in the VPC. * When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more * information, see Configuring a Lambda function to access resources in a VPC.
*/ VpcConfig?: VpcConfig; /** *Environment variables that are accessible from function code during execution.
*/ Environment?: Environment; /** *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.
*/ Runtime?: Runtime | string; /** *A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events * when they fail processing. For more information, see Dead-letter queues.
*/ DeadLetterConfig?: DeadLetterConfig; /** *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.
*/ KMSKeyArn?: string; /** *Set Mode to Active to sample and trace a subset of incoming requests with
* X-Ray.
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.
*/ RevisionId?: string; /** *A list of function layers * to add to the function's execution environment. Specify each layer by its ARN, including the version.
*/ Layers?: string[]; /** *Connection settings for an Amazon EFS file system.
*/ FileSystemConfigs?: FileSystemConfig[]; /** ** Container image configuration * values that override the values in the container image Docker file.
*/ ImageConfig?: ImageConfig; /** *The size of the function's /tmp directory in MB. The default value is 512, but can be any whole
* number between 512 and 10,240 MB.
The function's SnapStart setting.
*/ SnapStart?: SnapStart; } /** * @public */ export interface UpdateFunctionEventInvokeConfigRequest { /** *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.
*/ FunctionName: string | undefined; /** *A version number or alias name.
*/ Qualifier?: string; /** *The maximum number of times to retry when the function returns an error.
*/ MaximumRetryAttempts?: number; /** *The maximum age of a request that Lambda sends to a function for processing.
*/ MaximumEventAgeInSeconds?: number; /** *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.
*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.
*/ FunctionName: string | undefined; /** *The alias name.
*/ Qualifier?: string; /** *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.
The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *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 HTTP URL endpoint for your function.
*/ FunctionUrl: string | undefined; /** *The Amazon Resource Name (ARN) of your function.
*/ FunctionArn: string | undefined; /** *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.
The cross-origin resource sharing (CORS) settings * for your function URL.
*/ Cors?: Cors; /** *When the function URL was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ CreationTime: string | undefined; /** *When the function URL configuration was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
*/ LastModifiedTime: string | undefined; /** *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.