@aws-sdk/client-lambda

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { StreamingBlobTypes } from "@smithy/types"; import { LambdaServiceException as __BaseException } from "./LambdaServiceException"; /** * Limits that are related to concurrency and storage. All file and storage sizes are in bytes. * @public */ export interface AccountLimit { /** * The amount of storage space that you can use for all deployment packages and layer archives. * @public */ TotalCodeSize?: number; /** * The maximum size of a function's deployment package and layers when they're extracted. * @public */ CodeSizeUnzipped?: number; /** * The maximum size of a deployment package when it's uploaded directly to Lambda. Use Amazon S3 for larger * files. * @public */ CodeSizeZipped?: number; /** * The maximum number of simultaneous function executions. * @public */ ConcurrentExecutions?: number; /** * The maximum number of simultaneous function executions, minus the capacity that's reserved for individual * functions with <a>PutFunctionConcurrency</a>. * @public */ UnreservedConcurrentExecutions?: number; } /** * The number of functions and amount of storage in use. * @public */ export interface AccountUsage { /** * The amount of storage space, in bytes, that's being used by deployment packages and layer archives. * @public */ TotalCodeSize?: number; /** * The number of Lambda functions. * @public */ FunctionCount?: number; } /** * @public */ export interface AddLayerVersionPermissionRequest { /** * The name or Amazon Resource Name (ARN) of the layer. * @public */ LayerName: string | undefined; /** * The version number. * @public */ VersionNumber: number | undefined; /** * An identifier that distinguishes the policy from others on the same layer version. * @public */ StatementId: string | undefined; /** * The API action that grants access to the layer. For example, <code>lambda:GetLayerVersion</code>. * @public */ Action: string | undefined; /** * An account ID, or <code>*</code> to grant layer usage permission to all * accounts in an organization, or all Amazon Web Services accounts (if <code>organizationId</code> 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. * * @public */ Principal: string | undefined; /** * With the principal set to <code>*</code>, grant permission to all accounts in the specified * organization. * @public */ OrganizationId?: string; /** * 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. * @public */ RevisionId?: string; } /** * @public */ export interface AddLayerVersionPermissionResponse { /** * The permission statement. * @public */ Statement?: string; /** * A unique identifier for the current revision of the policy. * @public */ RevisionId?: string; } /** * One of the parameters in the request is not valid. * @public */ export declare class InvalidParameterValueException extends __BaseException { readonly name: "InvalidParameterValueException"; readonly $fault: "client"; /** * The exception type. * @public */ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>); } /** * The permissions policy for the resource is too large. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">Lambda quotas</a>. * @public */ export declare class PolicyLengthExceededException extends __BaseException { readonly name: "PolicyLengthExceededException"; readonly $fault: "client"; Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<PolicyLengthExceededException, __BaseException>); } /** * The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. * <ul> * <li> * * For AddPermission and RemovePermission API operations: Call <code>GetPolicy</code> to retrieve the latest RevisionId for your resource. * </li> * <li> * * For all other API operations: Call <code>GetFunction</code> or <code>GetAlias</code> to retrieve the latest RevisionId for your resource. * </li> * </ul> * @public */ export declare class PreconditionFailedException extends __BaseException { readonly name: "PreconditionFailedException"; readonly $fault: "client"; /** * The exception type. * @public */ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>); } /** * The resource already exists, or another operation is in progress. * @public */ export declare class ResourceConflictException extends __BaseException { readonly name: "ResourceConflictException"; readonly $fault: "client"; /** * The exception type. * @public */ Type?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>); } /** * The resource specified in the request does not exist. * @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>); } /** * The Lambda service encountered an internal error. * @public */ export declare class ServiceException extends __BaseException { readonly name: "ServiceException"; readonly $fault: "server"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<ServiceException, __BaseException>); } /** * @public * @enum */ export declare const ThrottleReason: { readonly CallerRateLimitExceeded: "CallerRateLimitExceeded"; readonly ConcurrentInvocationLimitExceeded: "ConcurrentInvocationLimitExceeded"; readonly ConcurrentSnapshotCreateLimitExceeded: "ConcurrentSnapshotCreateLimitExceeded"; readonly FunctionInvocationRateLimitExceeded: "FunctionInvocationRateLimitExceeded"; readonly ReservedFunctionConcurrentInvocationLimitExceeded: "ReservedFunctionConcurrentInvocationLimitExceeded"; readonly ReservedFunctionInvocationRateLimitExceeded: "ReservedFunctionInvocationRateLimitExceeded"; }; /** * @public */ export type ThrottleReason = (typeof ThrottleReason)[keyof typeof ThrottleReason]; /** * The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>. * @public */ export declare class TooManyRequestsException extends __BaseException { readonly name: "TooManyRequestsException"; readonly $fault: "client"; /** * The number of seconds the caller should wait before retrying. * @public */ retryAfterSeconds?: string; Type?: string; Reason?: ThrottleReason; /** * @internal */ constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>); } /** * @public * @enum */ export declare const FunctionUrlAuthType: { readonly AWS_IAM: "AWS_IAM"; readonly NONE: "NONE"; }; /** * @public */ export type FunctionUrlAuthType = (typeof FunctionUrlAuthType)[keyof typeof FunctionUrlAuthType]; /** * @public */ export interface AddPermissionRequest { /** * The name or ARN of the Lambda function, version, or alias. * * Name formats * * <ul> * <li> * * Function name – <code>my-function</code> (name-only), <code>my-function:v1</code> (with alias). * </li> * <li> * * Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:my-function</code>. * </li> * <li> * * Partial ARN – <code>123456789012:function:my-function</code>. * </li> * </ul> * 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. * @public */ FunctionName: string | undefined; /** * A statement identifier that differentiates the statement from others in the same policy. * @public */ StatementId: string | undefined; /** * The action that the principal can use on the function. For example, <code>lambda:InvokeFunction</code> or * <code>lambda:GetFunction</code>. * @public */ Action: string | undefined; /** * The Amazon Web Servicesservice or Amazon Web Services account that invokes the function. If you specify a * service, use <code>SourceArn</code> or <code>SourceAccount</code> to limit who can invoke the function through * that service. * @public */ Principal: string | undefined; /** * For Amazon Web Servicesservices, 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 <code>StringLike</code> operator. * @public */ SourceArn?: string; /** * For Amazon Web Servicesservice, the ID of the Amazon Web Services account that owns the resource. Use this * together with <code>SourceArn</code> 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. * @public */ SourceAccount?: string; /** * For Alexa Smart Home functions, a token that the invoker must supply. * @public */ EventSourceToken?: string; /** * Specify a version or alias to add permissions to a published version of the function. * @public */ 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. * @public */ RevisionId?: string; /** * The identifier for your organization in Organizations. Use this to grant permissions to all the * Amazon Web Services accounts under this organization. * @public */ PrincipalOrgID?: string; /** * The type of authentication that your function URL uses. Set to <code>AWS_IAM</code> if you want to restrict access to authenticated * users only. Set to <code>NONE</code> if you want to bypass IAM authentication to create a public endpoint. For more information, * see <a href="https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html">Security and auth model for Lambda function URLs</a>. * @public */ FunctionUrlAuthType?: FunctionUrlAuthType; } /** * @public */ export interface AddPermissionResponse { /** * The permission statement that's added to the function policy. * @public */ Statement?: string; } /** * The <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html">traffic-shifting</a> configuration of a Lambda function alias. * @public */ export interface AliasRoutingConfiguration { /** * The second version, and the percentage of traffic that's routed to it. * @public */ AdditionalVersionWeights?: Record<string, number>; } /** * Provides configuration information about a Lambda function <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">alias</a>. * @public */ export interface AliasConfiguration { /** * The Amazon Resource Name (ARN) of the alias. * @public */ AliasArn?: string; /** * The name of the alias. * @public */ Name?: string; /** * The function version that the alias invokes. * @public */ FunctionVersion?: string; /** * A description of the alias. * @public */ Description?: string; /** * The <a href="https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html">routing * configuration</a> of the alias. * @public */ RoutingConfig?: AliasRoutingConfiguration; /** * A unique identifier that changes when you update the alias. * @public */ RevisionId?: string; } /** * List of signing profiles that can sign a code package. * @public */ 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. * @public */ SigningProfileVersionArns: string[] | undefined; } /** * Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. * @public */ 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 * <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id">Customizable consumer group ID</a>. * @public */ ConsumerGroupId?: string; } /** * @public * @enum */ export declare const ApplicationLogLevel: { readonly Debug: "DEBUG"; readonly Error: "ERROR"; readonly Fatal: "FATAL"; readonly Info: "INFO"; readonly Trace: "TRACE"; readonly Warn: "WARN"; }; /** * @public */ export type ApplicationLogLevel = (typeof ApplicationLogLevel)[keyof typeof ApplicationLogLevel]; /** * @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 or ARN of the Lambda function. * * Name formats * * <ul> * <li> * * Function name - <code>MyFunction</code>. * </li> * <li> * * Function ARN - <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. * </li> * <li> * * Partial ARN - <code>123456789012:function:MyFunction</code>. * </li> * </ul> * The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 * characters in length. * @public */ FunctionName: string | undefined; /** * The name of the alias. * @public */ Name: string | undefined; /** * The function version that the alias invokes. * @public */ FunctionVersion: string | undefined; /** * A description of the alias. * @public */ Description?: string; /** * The <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing">routing * configuration</a> of the alias. * @public */ RoutingConfig?: AliasRoutingConfiguration; } /** * @public * @enum */ export declare const CodeSigningPolicy: { readonly Enforce: "Enforce"; readonly Warn: "Warn"; }; /** * @public */ export type CodeSigningPolicy = (typeof CodeSigningPolicy)[keyof typeof CodeSigningPolicy]; /** * Code signing configuration <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies">policies</a> specify the validation failure action for signature mismatch or * expiry. * @public */ export interface CodeSigningPolicies { /** * Code signing configuration policy for deployment validation failure. If you set the policy to * <code>Enforce</code>, Lambda blocks the deployment request if signature validation checks fail. If you set the * policy to <code>Warn</code>, Lambda allows the deployment and creates a CloudWatch log. * Default value: <code>Warn</code> * * @public */ UntrustedArtifactOnDeployment?: CodeSigningPolicy; } /** * @public */ export interface CreateCodeSigningConfigRequest { /** * Descriptive name for this code signing configuration. * @public */ Description?: string; /** * Signing profiles for this code signing configuration. * @public */ AllowedPublishers: AllowedPublishers | undefined; /** * The code signing policies define the actions to take if the validation checks fail. * @public */ CodeSigningPolicies?: CodeSigningPolicies; } /** * Details about a <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html">Code signing configuration</a>. * @public */ export interface CodeSigningConfig { /** * Unique identifer for the Code signing configuration. * @public */ CodeSigningConfigId: string | undefined; /** * The Amazon Resource Name (ARN) of the Code signing configuration. * @public */ CodeSigningConfigArn: string | undefined; /** * Code signing configuration description. * @public */ Description?: string; /** * List of allowed publishers. * @public */ AllowedPublishers: AllowedPublishers | undefined; /** * The code signing policy controls the validation failure action for signature mismatch or expiry. * @public */ 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). * @public */ LastModified: string | undefined; } /** * @public */ export interface CreateCodeSigningConfigResponse { /** * The code signing configuration. * @public */ CodeSigningConfig: CodeSigningConfig | undefined; } /** * A destination for events that failed processing. * @public */ export interface OnFailure { /** * The Amazon Resource Name (ARN) of the destination resource. * To retain records of <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations">asynchronous invocations</a>, * you can configure an Amazon SNS topic, Amazon SQS queue, Lambda function, * or Amazon EventBridge event bus as the destination. * To retain records of failed invocations from <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#event-source-mapping-destinations">Kinesis and * DynamoDB event sources</a>, you can configure an Amazon SNS topic or * Amazon SQS queue as the destination. * To retain records of failed invocations from <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-smaa-onfailure-destination">self-managed Kafka</a> or * <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-onfailure-destination">Amazon MSK</a>, * you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination. * @public */ Destination?: string; } /** * A destination for events that were processed successfully. * @public */ export interface OnSuccess { /** * The Amazon Resource Name (ARN) of the destination resource. * @public */ Destination?: string; } /** * A configuration object that specifies the destination of an event after Lambda processes it. * @public */ export interface DestinationConfig { /** * The destination configuration for successful invocations. * @public */ OnSuccess?: OnSuccess; /** * The destination configuration for failed invocations. * @public */ OnFailure?: OnFailure; } /** * @public * @enum */ export declare const FullDocument: { readonly Default: "Default"; readonly UpdateLookup: "UpdateLookup"; }; /** * @public */ export type FullDocument = (typeof FullDocument)[keyof typeof FullDocument]; /** * * Specific configuration settings for a DocumentDB event source. * * @public */ export interface DocumentDBEventSourceConfig { /** * * The name of the database to consume within the DocumentDB cluster. * * @public */ DatabaseName?: string; /** * * The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. * * @public */ 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. * * @public */ FullDocument?: FullDocument; } /** * * A structure within a <code>FilterCriteria</code> object that defines an event filtering pattern. * * @public */ export interface Filter { /** * * A filter pattern. For more information on the syntax of a filter pattern, see * <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax"> * Filter rule syntax</a>. * * @public */ Pattern?: string; } /** * * An object that contains the filters for an event source. * * @public */ export interface FilterCriteria { /** * * A list of filters. * * @public */ Filters?: Filter[]; } /** * @public * @enum */ export declare const FunctionResponseType: { readonly ReportBatchItemFailures: "ReportBatchItemFailures"; }; /** * @public */ export type FunctionResponseType = (typeof FunctionResponseType)[keyof typeof FunctionResponseType]; /** * (Amazon SQS only) The scaling configuration for the event source. To remove the configuration, pass an empty value. * @public */ export interface ScalingConfig { /** * Limits the number of concurrent instances that the Amazon SQS event source can invoke. * @public */ MaximumConcurrency?: number; } /** * @public * @enum */ export declare const EndPointType: { readonly KAFKA_BOOTSTRAP_SERVERS: "KAFKA_BOOTSTRAP_SERVERS"; }; /** * @public */ export type EndPointType = (typeof EndPointType)[keyof typeof EndPointType]; /** * The self-managed Apache Kafka cluster for your event source. * @public */ export interface SelfManagedEventSource { /** * The list of bootstrap servers for your Kafka brokers in the following format: <code>"KAFKA_BOOTSTRAP_SERVERS": * ["abc.xyz.com:xxxx","abc2.xyz.com:xxxx"]</code>. * @public */ Endpoints?: Partial<Record<EndPointType, string[]>>; } /** * Specific configuration settings for a self-managed Apache Kafka event source. * @public */ 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 * <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id">Customizable consumer group ID</a>. * @public */ 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]; /** * To secure and define access to your event source, you can specify the authentication protocol, VPC components, or virtual host. * @public */ export interface SourceAccessConfiguration { /** * The type of authentication protocol, VPC components, or virtual host for your event source. For example: <code>"Type":"SASL_SCRAM_512_AUTH"</code>. * <ul> * <li> * * <code>BASIC_AUTH</code> – (Amazon MQ) The Secrets Manager secret that stores your broker credentials. * </li> * <li> * * <code>BASIC_AUTH</code> – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. * </li> * <li> * * <code>VPC_SUBNET</code> – (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. * </li> * <li> * * <code>VPC_SECURITY_GROUP</code> – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers. * </li> * <li> * * <code>SASL_SCRAM_256_AUTH</code> – (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. * </li> * <li> * * <code>SASL_SCRAM_512_AUTH</code> – (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. * </li> * <li> * * <code>VIRTUAL_HOST</code> –- (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. * </li> * <li> * * <code>CLIENT_CERTIFICATE_TLS_AUTH</code> – (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. * </li> * <li> * * <code>SERVER_ROOT_CA_CERTIFICATE</code> – (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. * * </li> * </ul> * @public */ Type?: SourceAccessType; /** * The value for your chosen configuration in <code>Type</code>. For example: <code>"URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName"</code>. * @public */ URI?: string; } /** * @public * @enum */ export declare const EventSourcePosition: { readonly AT_TIMESTAMP: "AT_TIMESTAMP"; readonly LATEST: "LATEST"; readonly TRIM_HORIZON: "TRIM_HORIZON"; }; /** * @public */ export type EventSourcePosition = (typeof EventSourcePosition)[keyof typeof EventSourcePosition]; /** * @public */ export interface CreateEventSourceMappingRequest { /** * The Amazon Resource Name (ARN) of the event source. * <ul> * <li> * * Amazon Kinesis – The ARN of the data stream or a stream consumer. * </li> * <li> * * Amazon DynamoDB Streams – The ARN of the stream. * </li> * <li> * * Amazon Simple Queue Service – The ARN of the queue. * </li> * <li> * * Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc">cross-account event source mappings</a>). * </li> * <li> * * Amazon MQ – The ARN of the broker. * </li> * <li> * * Amazon DocumentDB – The ARN of the DocumentDB change stream. * </li> * </ul> * @public */ EventSourceArn?: string; /** * The name or ARN of the Lambda function. * * Name formats * * <ul> * <li> * * Function name – <code>MyFunction</code>. * </li> * <li> * * Function ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction</code>. * </li> * <li> * * Version or Alias ARN – <code>arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD</code>. * </li> * <li> * * Partial ARN – <code>123456789012:function:MyFunction</code>. * </li> * </ul> * The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 * characters in length. * @public */ FunctionName: string | undefined; /** * When true, the event source mapping is active. When false, Lambda pauses polling and invocation. * Default: True * @public */ 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). * <ul> * <li> * * Amazon Kinesis – Default 100. Max 10,000. * </li> * <li> * * Amazon DynamoDB Streams – Default 100. Max 10,000. * </li> * <li> * * Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. * </li> * <li> * * Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000. * </li> * <li> * * Self-managed Apache Kafka – Default 100. Max 10,000. * </li> * <li> * * Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000. * </li> * <li> * * DocumentDB – Default 100. Max 10,000. * </li> * </ul> * @public */ BatchSize?: number; /** * An object that defines the filter criteria that * determine whether Lambda should process an event. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html">Lambda event filtering</a>. * @public */ FilterCriteria?: FilterCriteria; /** * The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. * You can configure <code>MaximumBatchingWindowInSeconds</code> to any value from 0 seconds to 300 seconds in increments of seconds. * For Kinesis, DynamoDB, 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 <code>MaximumBatchingWindowInSeconds</code> 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 Kinesis, DynamoDB, and Amazon SQS event sources, when you set <code>BatchSize</code> to a value greater than 10, you must set <code>MaximumBatchingWindowInSeconds</code> to at least 1. * @public */ MaximumBatchingWindowInSeconds?: number; /** * (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently. * @public */ ParallelizationFactor?: number; /** * The position in a stream from which to start reading. Required for Amazon Kinesis and * Amazon DynamoDB Stream event sources. <code>AT_TIMESTAMP</code> is supported only for * Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka. * @public */ StartingPosition?: EventSourcePosition; /** * With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start * reading. <code>StartingPositionTimestamp</code> cannot be in the future. * @public */ StartingPositionTimestamp?: Date; /** * (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it. * @public */ DestinationConfig?: DestinationConfig; /** * (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1). * @public */ MaximumRecordAgeInSeconds?: number; /** * (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. * @public */ 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. * @public */ 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. * @public */ TumblingWindowInSeconds?: number; /** * The name of the Kafka topic. * @public */ Topics?: string[]; /** * (MQ) The name of the Amazon MQ broker destination queue to consume. * @public */ Queues?: string[]; /** * An array of authentication protocols or VPC components required to secure your event source. * @public */ SourceAccessConfigurations?: SourceAccessConfiguration[]; /** * The self-managed Apache Kafka cluster to receive records from. * @public */ SelfManagedEventSource?: SelfManagedEventSource; /** * (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. * @public */ FunctionResponseTypes?: FunctionResponseType[]; /** * Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. * @public */ AmazonManagedKafkaEventSourceConfig?: AmazonManagedKafkaEventSourceConfig; /** * Specific configuration settings for a self-managed Apache Kafka event source. * @public */ SelfManagedKafkaEventSourceConfig?: SelfManagedKafkaEventSourceConfig; /** * (Amazon SQS only) The scaling configuration for the event source. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency">Configuring maximum concurrency for Amazon SQS event sources</a>. * @public */ ScalingConfig?: ScalingConfig; /** * Specific configuration settings for a DocumentDB event source. * @public */ DocumentDBEventSourceConfig?: DocumentDBEventSourceConfig; /** * * The ARN of the Key Management Service (KMS) customer managed key that Lambda * uses to encrypt your function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics">filter criteria</a>. * By default, Lambda does not encrypt your filter criteria object. Specify this * property to encrypt data using your own customer managed key. * * @public */ KMSKeyArn?: string; } /** * An object that contains details about an error related to filter criteria encryption. * @public */ export interface FilterCriteriaError { /** * The KMS exception that resulted from filter criteria encryption or decryption. * @public */ ErrorCode?: string; /** * The error message. * @public */ Message?: string; } /** * A mapping between an Amazon Web Services resource and a Lambda function. For details, see <a>CreateEventSourceMapping</a>. * @public */ export interface EventSourceMappingConfiguration { /** * The identifier of the event source mapping. * @public */ UUID?: string; /** * The position in a stream from which to start reading. Required for Amazon Kinesis and * Amazon DynamoDB Stream event sources. <code>AT_TIMESTAMP</code> is supported only for * Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka. * @public */ StartingPosition?: EventSourcePosition; /** * With <code>StartingPosition</code> set to <code>AT_TIMESTAMP</code>, the time from which to start * reading. <code>StartingPositionTimestamp</code> cannot be in the future. * @public */ StartingPositionTimestamp?: Date; /** * 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 <code>BatchSize</code> to a value greater than 10, you must set <code>MaximumBatchingWindowInSeconds</code> to at least 1. * @public */ BatchSize?: number; /** * The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. * You can configure <code>MaximumBatchingWindowInSeconds</code> 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 <code>MaximumBatchingWindowInSeconds</code> 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 <code>BatchSize</code> to a value greater than 10, you must set <code>MaximumBatchingWindowInSeconds</code> to at least 1. * @public */ MaximumBatchingWindowInSeconds?: number; /** * (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1. * @public */ ParallelizationFactor?: number; /** * The Amazon Resource Name (ARN) of the event source. * @public */ EventSourceArn?: string; /** * An object that defines the filter criteria that * determine whether Lambda should process an event. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html">Lambda event filtering</a>. * If filter criteria is encrypted, this field shows up as <code>null</code> in the response * of ListEventSourceMapping API calls. You can view this field in plaintext in the response of * GetEventSourceMapping and DeleteEventSourceMapping calls if you have * <code>kms:Decrypt</code> permissions for the correct KMS key. * @public */ FilterCriteria?: FilterCriteria; /** * The ARN of the Lambda function. * @public */ FunctionArn?: string; /** * The date that the event source mapping was last updated or that its state changed. * @public */ LastModified?: Date; /** * The result of the last Lambda invocation of your function. * @public */ LastProcessingResult?: string; /** * The state of the event source mapping. It can be one of the following: <code>Creating</code>, * <code>Enabling</code>, <code>Enabled</code>, <code>Disabling</code>, <code>Disabled</code>, * <code>Updating</code>, or <code>Deleting</code>. * @public */ State?: string; /** * Indicates whether a user or Lambda made the last change to the event source mapping. * @public */ StateTransitionReason?: string; /** * (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it. * @public */ DestinationConfig?: DestinationConfig; /** * The name of the Kafka topic. * @public */ Topics?: string[]; /** * (Amazon MQ) The name of the Amazon MQ broker destination queue to consume. * @public */ Queues?: string[]; /** * An array of the authentication protocol, VPC components, or virtual host to secure and define your event source. * @public */ SourceAccessConfigurations?: SourceAccessConfiguration[]; /** * The self-managed Apache Kafka cluster for your event source. * @public */ 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. * <note> * The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed * </note> * @public */ MaximumRecordAgeInSeconds?: number; /** * (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false. * @public */ 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. * @public */ 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. * @public */ TumblingWindowInSeconds?: number; /** * (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping. * @public */ FunctionResponseTypes?: FunctionResponseType[]; /** * Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source. * @public */ AmazonManagedKafkaEventSourceConfig?: AmazonManagedKafkaEventSourceConfig; /** * Specific configuration settings for a self-managed Apache Kafka event source. * @public */ SelfManagedKafkaEventSourceConfig?: SelfManagedKafkaEventSourceConfig; /** * (Amazon SQS only) The scaling configuration for the event source. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency">Configuring maximum concurrency for Amazon SQS event sources</a>. * @public */ ScalingConfig?: ScalingConfig; /** * Specific configuration settings for a DocumentDB event source. * @public */ DocumentDBEventSourceConfig?: DocumentDBEventSourceConfig; /** * * The ARN of the Key Management Service (KMS) customer managed key that Lambda * uses to encrypt your function's <a href="https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics">filter criteria</a>. * @public */ KMSKeyArn?: string; /** * An object that contains details about an error related to filter criteria encryption. * @public */ FilterCriteriaError?: FilterCriteriaError; } /** * The specified code signing configuration does not exist. * @public */ export declare class CodeSigningConfigNotFoundException extends __BaseException { readonly name: "CodeSigningConfigNotFoundException"; readonly $fault: "client"; Type?: string; Message?: string; /** * @internal */ constructor(opts: __ExceptionOptionType<CodeSigningConfigNotFoundException, __BaseException>); } /** * Your Amazon Web Services account has exceeded its maximum total code size. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">Lambda quotas</a>. * @public */ export declare class CodeStorageExceededException extends __BaseException { readonly name: "CodeStorageExceededException";