lambda.d.ts (74233B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class Lambda extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Lambda.Types.ClientConfiguration) 13 config: Config & Lambda.Types.ClientConfiguration; 14 /** 15 * Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function. For information about the push model, see AWS Lambda: How it Works. If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:AddPermission action. 16 */ 17 addPermission(params: Lambda.Types.AddPermissionRequest, callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request<Lambda.Types.AddPermissionResponse, AWSError>; 18 /** 19 * Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function. For information about the push model, see AWS Lambda: How it Works. If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:AddPermission action. 20 */ 21 addPermission(callback?: (err: AWSError, data: Lambda.Types.AddPermissionResponse) => void): Request<Lambda.Types.AddPermissionResponse, AWSError>; 22 /** 23 * Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases. Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action. 24 */ 25 createAlias(params: Lambda.Types.CreateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 26 /** 27 * Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases. Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action. 28 */ 29 createAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 30 /** 31 * Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream. This association between a stream source and a Lambda function is called the event source mapping. This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide. You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body. Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources. If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:CreateEventSourceMapping action. 32 */ 33 createEventSourceMapping(params: Lambda.Types.CreateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 34 /** 35 * Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream. This association between a stream source and a Lambda function is called the event source mapping. This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide. You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body. Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources. If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:CreateEventSourceMapping action. 36 */ 37 createEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 38 /** 39 * Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive. If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:CreateFunction action. 40 */ 41 createFunction(params: Lambda.Types.CreateFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 42 /** 43 * Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive. If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:CreateFunction action. 44 */ 45 createFunction(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 46 /** 47 * Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:DeleteAlias action. 48 */ 49 deleteAlias(params: Lambda.Types.DeleteAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 50 /** 51 * Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:DeleteAlias action. 52 */ 53 deleteAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 54 /** 55 * Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source. This operation requires permission for the lambda:DeleteEventSourceMapping action. 56 */ 57 deleteEventSourceMapping(params: Lambda.Types.DeleteEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 58 /** 59 * Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source. This operation requires permission for the lambda:DeleteEventSourceMapping action. 60 */ 61 deleteEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 62 /** 63 * Deletes the specified Lambda function code and configuration. If you are using the versioning feature and you don't specify a function version in your DeleteFunction request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases. When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. This operation requires permission for the lambda:DeleteFunction action. 64 */ 65 deleteFunction(params: Lambda.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 66 /** 67 * Deletes the specified Lambda function code and configuration. If you are using the versioning feature and you don't specify a function version in your DeleteFunction request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases. When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly. This operation requires permission for the lambda:DeleteFunction action. 68 */ 69 deleteFunction(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 70 /** 71 * Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:GetAlias action. 72 */ 73 getAlias(params: Lambda.Types.GetAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 74 /** 75 * Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:GetAlias action. 76 */ 77 getAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 78 /** 79 * Returns configuration information for the specified event source mapping (see CreateEventSourceMapping). This operation requires permission for the lambda:GetEventSourceMapping action. 80 */ 81 getEventSourceMapping(params: Lambda.Types.GetEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 82 /** 83 * Returns configuration information for the specified event source mapping (see CreateEventSourceMapping). This operation requires permission for the lambda:GetEventSourceMapping action. 84 */ 85 getEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 86 /** 87 * Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:GetFunction action. 88 */ 89 getFunction(params: Lambda.Types.GetFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>; 90 /** 91 * Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function. Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:GetFunction action. 92 */ 93 getFunction(callback?: (err: AWSError, data: Lambda.Types.GetFunctionResponse) => void): Request<Lambda.Types.GetFunctionResponse, AWSError>; 94 /** 95 * Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction. If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:GetFunctionConfiguration operation. 96 */ 97 getFunctionConfiguration(params: Lambda.Types.GetFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 98 /** 99 * Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction. If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:GetFunctionConfiguration operation. 100 */ 101 getFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 102 /** 103 * Returns the resource policy associated with the specified Lambda function. If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. For information about adding permissions, see AddPermission. You need permission for the lambda:GetPolicy action. 104 */ 105 getPolicy(params: Lambda.Types.GetPolicyRequest, callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request<Lambda.Types.GetPolicyResponse, AWSError>; 106 /** 107 * Returns the resource policy associated with the specified Lambda function. If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. For information about adding permissions, see AddPermission. You need permission for the lambda:GetPolicy action. 108 */ 109 getPolicy(callback?: (err: AWSError, data: Lambda.Types.GetPolicyResponse) => void): Request<Lambda.Types.GetPolicyResponse, AWSError>; 110 /** 111 * Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually. If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier parameter in the request. If you don't provide the Qualifier parameter, the $LATEST version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:InvokeFunction action. 112 */ 113 invoke(params: Lambda.Types.InvocationRequest, callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request<Lambda.Types.InvocationResponse, AWSError>; 114 /** 115 * Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually. If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier parameter in the request. If you don't provide the Qualifier parameter, the $LATEST version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:InvokeFunction action. 116 */ 117 invoke(callback?: (err: AWSError, data: Lambda.Types.InvocationResponse) => void): Request<Lambda.Types.InvocationResponse, AWSError>; 118 /** 119 * This API is deprecated. We recommend you use Invoke API (see Invoke). Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console. This operation requires permission for the lambda:InvokeFunction action. 120 */ 121 invokeAsync(params: Lambda.Types.InvokeAsyncRequest, callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request<Lambda.Types.InvokeAsyncResponse, AWSError>; 122 /** 123 * This API is deprecated. We recommend you use Invoke API (see Invoke). Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console. This operation requires permission for the lambda:InvokeFunction action. 124 */ 125 invokeAsync(callback?: (err: AWSError, data: Lambda.Types.InvokeAsyncResponse) => void): Request<Lambda.Types.InvokeAsyncResponse, AWSError>; 126 /** 127 * Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:ListAliases action. 128 */ 129 listAliases(params: Lambda.Types.ListAliasesRequest, callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request<Lambda.Types.ListAliasesResponse, AWSError>; 130 /** 131 * Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:ListAliases action. 132 */ 133 listAliases(callback?: (err: AWSError, data: Lambda.Types.ListAliasesResponse) => void): Request<Lambda.Types.ListAliasesResponse, AWSError>; 134 /** 135 * Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping). For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings. If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:ListEventSourceMappings action. 136 */ 137 listEventSourceMappings(params: Lambda.Types.ListEventSourceMappingsRequest, callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request<Lambda.Types.ListEventSourceMappingsResponse, AWSError>; 138 /** 139 * Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping). For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings. If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:ListEventSourceMappings action. 140 */ 141 listEventSourceMappings(callback?: (err: AWSError, data: Lambda.Types.ListEventSourceMappingsResponse) => void): Request<Lambda.Types.ListEventSourceMappingsResponse, AWSError>; 142 /** 143 * Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function. This operation requires permission for the lambda:ListFunctions action. If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 144 */ 145 listFunctions(params: Lambda.Types.ListFunctionsRequest, callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request<Lambda.Types.ListFunctionsResponse, AWSError>; 146 /** 147 * Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function. This operation requires permission for the lambda:ListFunctions action. If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 148 */ 149 listFunctions(callback?: (err: AWSError, data: Lambda.Types.ListFunctionsResponse) => void): Request<Lambda.Types.ListFunctionsResponse, AWSError>; 150 /** 151 * List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 152 */ 153 listVersionsByFunction(params: Lambda.Types.ListVersionsByFunctionRequest, callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request<Lambda.Types.ListVersionsByFunctionResponse, AWSError>; 154 /** 155 * List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 156 */ 157 listVersionsByFunction(callback?: (err: AWSError, data: Lambda.Types.ListVersionsByFunctionResponse) => void): Request<Lambda.Types.ListVersionsByFunctionResponse, AWSError>; 158 /** 159 * Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 160 */ 161 publishVersion(params: Lambda.Types.PublishVersionRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 162 /** 163 * Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. 164 */ 165 publishVersion(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 166 /** 167 * You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. Note that removal of a permission will cause an active event source to lose permission to the function. You need permission for the lambda:RemovePermission action. 168 */ 169 removePermission(params: Lambda.Types.RemovePermissionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 170 /** 171 * You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission. If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases. Note that removal of a permission will cause an active event source to lose permission to the function. You need permission for the lambda:RemovePermission action. 172 */ 173 removePermission(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 174 /** 175 * Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:UpdateAlias action. 176 */ 177 updateAlias(params: Lambda.Types.UpdateAliasRequest, callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 178 /** 179 * Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases. This requires permission for the lambda:UpdateAlias action. 180 */ 181 updateAlias(callback?: (err: AWSError, data: Lambda.Types.AliasConfiguration) => void): Request<Lambda.Types.AliasConfiguration, AWSError>; 182 /** 183 * You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping. If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset. This operation requires permission for the lambda:UpdateEventSourceMapping action. 184 */ 185 updateEventSourceMapping(params: Lambda.Types.UpdateEventSourceMappingRequest, callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 186 /** 187 * You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping. If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset. This operation requires permission for the lambda:UpdateEventSourceMapping action. 188 */ 189 updateEventSourceMapping(callback?: (err: AWSError, data: Lambda.Types.EventSourceMappingConfiguration) => void): Request<Lambda.Types.EventSourceMappingConfiguration, AWSError>; 190 /** 191 * Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionCode action. 192 */ 193 updateFunctionCode(params: Lambda.Types.UpdateFunctionCodeRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 194 /** 195 * Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionCode action. 196 */ 197 updateFunctionCode(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 198 /** 199 * Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionConfiguration action. 200 */ 201 updateFunctionConfiguration(params: Lambda.Types.UpdateFunctionConfigurationRequest, callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 202 /** 203 * Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code. If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases. This operation requires permission for the lambda:UpdateFunctionConfiguration action. 204 */ 205 updateFunctionConfiguration(callback?: (err: AWSError, data: Lambda.Types.FunctionConfiguration) => void): Request<Lambda.Types.FunctionConfiguration, AWSError>; 206 } 207 declare namespace Lambda.Types { 208 export type Action = string; 209 export interface AddPermissionRequest { 210 /** 211 * Name of the Lambda function whose resource policy you are updating by adding a new permission. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 212 */ 213 FunctionName: FunctionName; 214 /** 215 * A unique statement identifier. 216 */ 217 StatementId: StatementId; 218 /** 219 * The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions. 220 */ 221 Action: Action; 222 /** 223 * The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function. 224 */ 225 Principal: Principal; 226 /** 227 * This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function. If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3. 228 */ 229 SourceArn?: Arn; 230 /** 231 * This parameter is used for S3, SES, CloudWatch Logs and CloudWatch Rules only. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account. 232 */ 233 SourceAccount?: SourceOwner; 234 /** 235 * A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions. 236 */ 237 EventSourceToken?: EventSourceToken; 238 /** 239 * You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN: arn:aws:lambda:aws-region:acct-id:function:function-name:2 If you specify an alias name, for example PROD, then the permission is valid only for requests made using the alias ARN: arn:aws:lambda:aws-region:acct-id:function:function-name:PROD If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN. arn:aws:lambda:aws-region:acct-id:function:function-name 240 */ 241 Qualifier?: Qualifier; 242 } 243 export interface AddPermissionResponse { 244 /** 245 * The permission statement you specified in the request. The response returns the same as a string using a backslash ("\") as an escape character in the JSON. 246 */ 247 Statement?: String; 248 } 249 export type Alias = string; 250 export interface AliasConfiguration { 251 /** 252 * Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA. 253 */ 254 AliasArn?: FunctionArn; 255 /** 256 * Alias name. 257 */ 258 Name?: Alias; 259 /** 260 * Function version to which the alias points. 261 */ 262 FunctionVersion?: Version; 263 /** 264 * Alias description. 265 */ 266 Description?: Description; 267 } 268 export type AliasList = AliasConfiguration[]; 269 export type Arn = string; 270 export type BatchSize = number; 271 export type _Blob = Buffer|Uint8Array|Blob|string; 272 export type BlobStream = Buffer|Uint8Array|Blob|string; 273 export type Boolean = boolean; 274 export interface CreateAliasRequest { 275 /** 276 * Name of the Lambda function for which you want to create an alias. 277 */ 278 FunctionName: FunctionName; 279 /** 280 * Name for the alias you are creating. 281 */ 282 Name: Alias; 283 /** 284 * Lambda function version for which you are creating the alias. 285 */ 286 FunctionVersion: Version; 287 /** 288 * Description of the alias. 289 */ 290 Description?: Description; 291 } 292 export interface CreateEventSourceMappingRequest { 293 /** 294 * The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON. 295 */ 296 EventSourceArn: Arn; 297 /** 298 * The Lambda function to invoke when AWS Lambda detects an event on the stream. You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 299 */ 300 FunctionName: FunctionName; 301 /** 302 * Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true. 303 */ 304 Enabled?: Enabled; 305 /** 306 * The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records. 307 */ 308 BatchSize?: BatchSize; 309 /** 310 * The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference. 311 */ 312 StartingPosition: EventSourcePosition; 313 } 314 export interface CreateFunctionRequest { 315 /** 316 * The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as Invoke. 317 */ 318 FunctionName: FunctionName; 319 /** 320 * The runtime environment for the Lambda function you are uploading. To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs". 321 */ 322 Runtime: Runtime; 323 /** 324 * The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works. 325 */ 326 Role: RoleArn; 327 /** 328 * The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java). 329 */ 330 Handler: Handler; 331 /** 332 * The code for the Lambda function. 333 */ 334 Code: FunctionCode; 335 /** 336 * A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit. 337 */ 338 Description?: Description; 339 /** 340 * The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. 341 */ 342 Timeout?: Timeout; 343 /** 344 * The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB. 345 */ 346 MemorySize?: MemorySize; 347 /** 348 * This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation. 349 */ 350 Publish?: Boolean; 351 /** 352 * If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID. 353 */ 354 VpcConfig?: VpcConfig; 355 Environment?: Environment; 356 /** 357 * The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key. 358 */ 359 KMSKeyArn?: KMSKeyArn; 360 } 361 export type _Date = Date; 362 export interface DeleteAliasRequest { 363 /** 364 * The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing. 365 */ 366 FunctionName: FunctionName; 367 /** 368 * Name of the alias to delete. 369 */ 370 Name: Alias; 371 } 372 export interface DeleteEventSourceMappingRequest { 373 /** 374 * The event source mapping ID. 375 */ 376 UUID: String; 377 } 378 export interface DeleteFunctionRequest { 379 /** 380 * The Lambda function to delete. You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 381 */ 382 FunctionName: FunctionName; 383 /** 384 * Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases. You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias. If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases. 385 */ 386 Qualifier?: Qualifier; 387 } 388 export type Description = string; 389 export type Enabled = boolean; 390 export interface Environment { 391 /** 392 * The key-value pairs that represent your environment's configuration settings. The value you specify cannot contain a ",". 393 */ 394 Variables?: EnvironmentVariables; 395 } 396 export interface EnvironmentError { 397 /** 398 * The error code returned by the environment error object. 399 */ 400 ErrorCode?: String; 401 /** 402 * The message returned by the environment error object. 403 */ 404 Message?: String; 405 } 406 export interface EnvironmentResponse { 407 /** 408 * The key-value pairs returned that represent your environment's configuration settings or error information. 409 */ 410 Variables?: EnvironmentVariables; 411 Error?: EnvironmentError; 412 } 413 export type EnvironmentVariableName = string; 414 export type EnvironmentVariableValue = string; 415 export type EnvironmentVariables = {[key: string]: EnvironmentVariableValue}; 416 export interface EventSourceMappingConfiguration { 417 /** 418 * The AWS Lambda assigned opaque identifier for the mapping. 419 */ 420 UUID?: String; 421 /** 422 * The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. 423 */ 424 BatchSize?: BatchSize; 425 /** 426 * The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events. 427 */ 428 EventSourceArn?: Arn; 429 /** 430 * The Lambda function to invoke when AWS Lambda detects an event on the stream. 431 */ 432 FunctionArn?: FunctionArn; 433 /** 434 * The UTC time string indicating the last time the event mapping was updated. 435 */ 436 LastModified?: _Date; 437 /** 438 * The result of the last AWS Lambda invocation of your Lambda function. 439 */ 440 LastProcessingResult?: String; 441 /** 442 * The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting. 443 */ 444 State?: String; 445 /** 446 * The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition. 447 */ 448 StateTransitionReason?: String; 449 } 450 export type EventSourceMappingsList = EventSourceMappingConfiguration[]; 451 export type EventSourcePosition = "TRIM_HORIZON"|"LATEST"|string; 452 export type EventSourceToken = string; 453 export type FunctionArn = string; 454 export interface FunctionCode { 455 /** 456 * The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide. 457 */ 458 ZipFile?: _Blob; 459 /** 460 * Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function. 461 */ 462 S3Bucket?: S3Bucket; 463 /** 464 * The Amazon S3 object (the deployment package) key name you want to upload. 465 */ 466 S3Key?: S3Key; 467 /** 468 * The Amazon S3 object (the deployment package) version you want to upload. 469 */ 470 S3ObjectVersion?: S3ObjectVersion; 471 } 472 export interface FunctionCodeLocation { 473 /** 474 * The repository from which you can download the function. 475 */ 476 RepositoryType?: String; 477 /** 478 * The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes. 479 */ 480 Location?: String; 481 } 482 export interface FunctionConfiguration { 483 /** 484 * The name of the function. 485 */ 486 FunctionName?: FunctionName; 487 /** 488 * The Amazon Resource Name (ARN) assigned to the function. 489 */ 490 FunctionArn?: FunctionArn; 491 /** 492 * The runtime environment for the Lambda function. To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs". 493 */ 494 Runtime?: Runtime; 495 /** 496 * The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. 497 */ 498 Role?: RoleArn; 499 /** 500 * The function Lambda calls to begin executing your function. 501 */ 502 Handler?: Handler; 503 /** 504 * The size, in bytes, of the function .zip file you uploaded. 505 */ 506 CodeSize?: Long; 507 /** 508 * The user-provided description. 509 */ 510 Description?: Description; 511 /** 512 * The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. 513 */ 514 Timeout?: Timeout; 515 /** 516 * The memory size, in MB, you configured for the function. Must be a multiple of 64 MB. 517 */ 518 MemorySize?: MemorySize; 519 /** 520 * The time stamp of the last time you updated the function. 521 */ 522 LastModified?: Timestamp; 523 /** 524 * It is the SHA256 hash of your function deployment package. 525 */ 526 CodeSha256?: String; 527 /** 528 * The version of the Lambda function. 529 */ 530 Version?: Version; 531 /** 532 * VPC configuration associated with your Lambda function. 533 */ 534 VpcConfig?: VpcConfigResponse; 535 /** 536 * The parent object that contains your environment's configuration settings. 537 */ 538 Environment?: EnvironmentResponse; 539 /** 540 * The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key. 541 */ 542 KMSKeyArn?: KMSKeyArn; 543 } 544 export type FunctionList = FunctionConfiguration[]; 545 export type FunctionName = string; 546 export interface GetAliasRequest { 547 /** 548 * Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name. 549 */ 550 FunctionName: FunctionName; 551 /** 552 * Name of the alias for which you want to retrieve information. 553 */ 554 Name: Alias; 555 } 556 export interface GetEventSourceMappingRequest { 557 /** 558 * The AWS Lambda assigned ID of the event source mapping. 559 */ 560 UUID: String; 561 } 562 export interface GetFunctionConfigurationRequest { 563 /** 564 * The name of the Lambda function for which you want to retrieve the configuration information. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 565 */ 566 FunctionName: FunctionName; 567 /** 568 * Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version. 569 */ 570 Qualifier?: Qualifier; 571 } 572 export interface GetFunctionRequest { 573 /** 574 * The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 575 */ 576 FunctionName: FunctionName; 577 /** 578 * Using this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function. 579 */ 580 Qualifier?: Qualifier; 581 } 582 export interface GetFunctionResponse { 583 Configuration?: FunctionConfiguration; 584 Code?: FunctionCodeLocation; 585 } 586 export interface GetPolicyRequest { 587 /** 588 * Function name whose resource policy you want to retrieve. You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 589 */ 590 FunctionName: FunctionName; 591 /** 592 * You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN. 593 */ 594 Qualifier?: Qualifier; 595 } 596 export interface GetPolicyResponse { 597 /** 598 * The resource policy associated with the specified function. The response returns the same as a string using a backslash ("\") as an escape character in the JSON. 599 */ 600 Policy?: String; 601 } 602 export type Handler = string; 603 export type HttpStatus = number; 604 export type Integer = number; 605 export interface InvocationRequest { 606 /** 607 * The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 608 */ 609 FunctionName: FunctionName; 610 /** 611 * By default, the Invoke API assumes RequestResponse invocation type. You can optionally request asynchronous execution by specifying Event as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying DryRun as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it. 612 */ 613 InvocationType?: InvocationType; 614 /** 615 * You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header. 616 */ 617 LogType?: LogType; 618 /** 619 * Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide. The ClientContext JSON must be base64-encoded. 620 */ 621 ClientContext?: String; 622 /** 623 * JSON that you want to provide to your Lambda function as input. 624 */ 625 Payload?: _Blob; 626 /** 627 * You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points. If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version. 628 */ 629 Qualifier?: Qualifier; 630 } 631 export interface InvocationResponse { 632 /** 633 * The HTTP status code will be in the 200 range for successful request. For the RequestResonse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204. 634 */ 635 StatusCode?: Integer; 636 /** 637 * Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model. 638 */ 639 FunctionError?: String; 640 /** 641 * It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested. 642 */ 643 LogResult?: String; 644 /** 645 * It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse. In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message. 646 */ 647 Payload?: _Blob; 648 } 649 export type InvocationType = "Event"|"RequestResponse"|"DryRun"|string; 650 export interface InvokeAsyncRequest { 651 /** 652 * The Lambda function name. 653 */ 654 FunctionName: FunctionName; 655 /** 656 * JSON that you want to provide to your Lambda function as input. 657 */ 658 InvokeArgs: BlobStream; 659 } 660 export interface InvokeAsyncResponse { 661 /** 662 * It will be 202 upon success. 663 */ 664 Status?: HttpStatus; 665 } 666 export type KMSKeyArn = string; 667 export interface ListAliasesRequest { 668 /** 669 * Lambda function name for which the alias is created. 670 */ 671 FunctionName: FunctionName; 672 /** 673 * If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function. 674 */ 675 FunctionVersion?: Version; 676 /** 677 * Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing. 678 */ 679 Marker?: String; 680 /** 681 * Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0. 682 */ 683 MaxItems?: MaxListItems; 684 } 685 export interface ListAliasesResponse { 686 /** 687 * A string, present if there are more aliases. 688 */ 689 NextMarker?: String; 690 /** 691 * A list of aliases. 692 */ 693 Aliases?: AliasList; 694 } 695 export interface ListEventSourceMappingsRequest { 696 /** 697 * The Amazon Resource Name (ARN) of the Amazon Kinesis stream. (This parameter is optional.) 698 */ 699 EventSourceArn?: Arn; 700 /** 701 * The name of the Lambda function. You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 702 */ 703 FunctionName?: FunctionName; 704 /** 705 * Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off. 706 */ 707 Marker?: String; 708 /** 709 * Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0. 710 */ 711 MaxItems?: MaxListItems; 712 } 713 export interface ListEventSourceMappingsResponse { 714 /** 715 * A string, present if there are more event source mappings. 716 */ 717 NextMarker?: String; 718 /** 719 * An array of EventSourceMappingConfiguration objects. 720 */ 721 EventSourceMappings?: EventSourceMappingsList; 722 } 723 export interface ListFunctionsRequest { 724 /** 725 * Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing. 726 */ 727 Marker?: String; 728 /** 729 * Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0. 730 */ 731 MaxItems?: MaxListItems; 732 } 733 export interface ListFunctionsResponse { 734 /** 735 * A string, present if there are more functions. 736 */ 737 NextMarker?: String; 738 /** 739 * A list of Lambda functions. 740 */ 741 Functions?: FunctionList; 742 } 743 export interface ListVersionsByFunctionRequest { 744 /** 745 * Function name whose versions to list. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 746 */ 747 FunctionName: FunctionName; 748 /** 749 * Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing. 750 */ 751 Marker?: String; 752 /** 753 * Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0. 754 */ 755 MaxItems?: MaxListItems; 756 } 757 export interface ListVersionsByFunctionResponse { 758 /** 759 * A string, present if there are more function versions. 760 */ 761 NextMarker?: String; 762 /** 763 * A list of Lambda function versions. 764 */ 765 Versions?: FunctionList; 766 } 767 export type LogType = "None"|"Tail"|string; 768 export type Long = number; 769 export type MaxListItems = number; 770 export type MemorySize = number; 771 export type Principal = string; 772 export interface PublishVersionRequest { 773 /** 774 * The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 775 */ 776 FunctionName: FunctionName; 777 /** 778 * The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the $LATEST version for the publication to succeed. 779 */ 780 CodeSha256?: String; 781 /** 782 * The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version. 783 */ 784 Description?: Description; 785 } 786 export type Qualifier = string; 787 export interface RemovePermissionRequest { 788 /** 789 * Lambda function whose resource policy you want to remove a permission from. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 790 */ 791 FunctionName: FunctionName; 792 /** 793 * Statement ID of the permission to remove. 794 */ 795 StatementId: StatementId; 796 /** 797 * You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN. 798 */ 799 Qualifier?: Qualifier; 800 } 801 export type RoleArn = string; 802 export type Runtime = "nodejs"|"nodejs4.3"|"java8"|"python2.7"|string; 803 export type S3Bucket = string; 804 export type S3Key = string; 805 export type S3ObjectVersion = string; 806 export type SecurityGroupId = string; 807 export type SecurityGroupIds = SecurityGroupId[]; 808 export type SourceOwner = string; 809 export type StatementId = string; 810 export type String = string; 811 export type SubnetId = string; 812 export type SubnetIds = SubnetId[]; 813 export type ThrottleReason = "ConcurrentInvocationLimitExceeded"|"FunctionInvocationRateLimitExceeded"|"CallerRateLimitExceeded"|string; 814 export type Timeout = number; 815 export type Timestamp = string; 816 export interface UpdateAliasRequest { 817 /** 818 * The function name for which the alias is created. 819 */ 820 FunctionName: FunctionName; 821 /** 822 * The alias name. 823 */ 824 Name: Alias; 825 /** 826 * Using this parameter you can change the Lambda function version to which the alias points. 827 */ 828 FunctionVersion?: Version; 829 /** 830 * You can change the description of the alias using this parameter. 831 */ 832 Description?: Description; 833 } 834 export interface UpdateEventSourceMappingRequest { 835 /** 836 * The event source mapping identifier. 837 */ 838 UUID: String; 839 /** 840 * The Lambda function to which you want the stream records sent. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 841 */ 842 FunctionName?: FunctionName; 843 /** 844 * Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream. 845 */ 846 Enabled?: Enabled; 847 /** 848 * The maximum number of stream records that can be sent to your Lambda function for a single invocation. 849 */ 850 BatchSize?: BatchSize; 851 } 852 export interface UpdateFunctionCodeRequest { 853 /** 854 * The existing Lambda function name whose code you want to replace. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 855 */ 856 FunctionName: FunctionName; 857 /** 858 * The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, go to Execution Permissions in the AWS Lambda Developer Guide. 859 */ 860 ZipFile?: _Blob; 861 /** 862 * Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function. 863 */ 864 S3Bucket?: S3Bucket; 865 /** 866 * The Amazon S3 object (the deployment package) key name you want to upload. 867 */ 868 S3Key?: S3Key; 869 /** 870 * The Amazon S3 object (the deployment package) version you want to upload. 871 */ 872 S3ObjectVersion?: S3ObjectVersion; 873 /** 874 * This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation. 875 */ 876 Publish?: Boolean; 877 } 878 export interface UpdateFunctionConfigurationRequest { 879 /** 880 * The name of the Lambda function. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length. 881 */ 882 FunctionName: FunctionName; 883 /** 884 * The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function. 885 */ 886 Role?: RoleArn; 887 /** 888 * The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function. 889 */ 890 Handler?: Handler; 891 /** 892 * A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit. 893 */ 894 Description?: Description; 895 /** 896 * The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. 897 */ 898 Timeout?: Timeout; 899 /** 900 * The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB. 901 */ 902 MemorySize?: MemorySize; 903 VpcConfig?: VpcConfig; 904 /** 905 * The parent object that contains your environment's configuration settings. 906 */ 907 Environment?: Environment; 908 /** 909 * The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string ("") for this parameter. 910 */ 911 KMSKeyArn?: KMSKeyArn; 912 /** 913 * The runtime environment for the Lambda function. To use the Node.js runtime v4.3, set the value to "nodejs4.3". To use earlier runtime (v0.10.42), set the value to "nodejs". 914 */ 915 Runtime?: Runtime; 916 } 917 export type Version = string; 918 export interface VpcConfig { 919 /** 920 * A list of one or more subnet IDs in your VPC. 921 */ 922 SubnetIds?: SubnetIds; 923 /** 924 * A list of one or more security groups IDs in your VPC. 925 */ 926 SecurityGroupIds?: SecurityGroupIds; 927 } 928 export interface VpcConfigResponse { 929 /** 930 * A list of subnet IDs associated with the Lambda function. 931 */ 932 SubnetIds?: SubnetIds; 933 /** 934 * A list of security group IDs associated with the Lambda function. 935 */ 936 SecurityGroupIds?: SecurityGroupIds; 937 /** 938 * The VPC ID associated with you Lambda function. 939 */ 940 VpcId?: VpcId; 941 } 942 export type VpcId = string; 943 /** 944 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 945 */ 946 export type apiVersion = "2014-11-11"|"2015-03-31"|"latest"|string; 947 export interface ClientApiVersions { 948 /** 949 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 950 */ 951 apiVersion?: apiVersion; 952 } 953 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 954 } 955 export = Lambda;