@aws-sdk/client-lambda 3.655.0 → 3.658.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/dist-types/commands/AddLayerVersionPermissionCommand.d.ts +21 -0
  2. package/dist-types/commands/AddPermissionCommand.d.ts +40 -0
  3. package/dist-types/commands/CreateAliasCommand.d.ts +23 -0
  4. package/dist-types/commands/CreateEventSourceMappingCommand.d.ts +24 -0
  5. package/dist-types/commands/CreateFunctionCommand.d.ts +64 -0
  6. package/dist-types/commands/DeleteAliasCommand.d.ts +12 -0
  7. package/dist-types/commands/DeleteEventSourceMappingCommand.d.ts +22 -0
  8. package/dist-types/commands/DeleteFunctionCommand.d.ts +12 -0
  9. package/dist-types/commands/DeleteFunctionConcurrencyCommand.d.ts +11 -0
  10. package/dist-types/commands/DeleteFunctionEventInvokeConfigCommand.d.ts +12 -0
  11. package/dist-types/commands/DeleteLayerVersionCommand.d.ts +12 -0
  12. package/dist-types/commands/DeleteProvisionedConcurrencyConfigCommand.d.ts +12 -0
  13. package/dist-types/commands/GetAccountSettingsCommand.d.ts +24 -0
  14. package/dist-types/commands/GetAliasCommand.d.ts +21 -0
  15. package/dist-types/commands/GetEventSourceMappingCommand.d.ts +27 -0
  16. package/dist-types/commands/GetFunctionCommand.d.ts +50 -0
  17. package/dist-types/commands/GetFunctionConcurrencyCommand.d.ts +16 -0
  18. package/dist-types/commands/GetFunctionConfigurationCommand.d.ts +41 -0
  19. package/dist-types/commands/GetFunctionEventInvokeConfigCommand.d.ts +26 -0
  20. package/dist-types/commands/GetLayerVersionByArnCommand.d.ts +28 -0
  21. package/dist-types/commands/GetLayerVersionCommand.d.ts +31 -0
  22. package/dist-types/commands/GetPolicyCommand.d.ts +18 -0
  23. package/dist-types/commands/GetProvisionedConcurrencyConfigCommand.d.ts +42 -0
  24. package/dist-types/commands/InvokeAsyncCommand.d.ts +17 -0
  25. package/dist-types/commands/InvokeCommand.d.ts +39 -0
  26. package/dist-types/commands/ListAliasesCommand.d.ts +36 -0
  27. package/dist-types/commands/ListEventSourceMappingsCommand.d.ts +26 -0
  28. package/dist-types/commands/ListFunctionEventInvokeConfigsCommand.d.ts +29 -0
  29. package/dist-types/commands/ListFunctionsCommand.d.ts +57 -0
  30. package/dist-types/commands/ListLayerVersionsCommand.d.ts +35 -0
  31. package/dist-types/commands/ListLayersCommand.d.ts +31 -0
  32. package/dist-types/commands/ListProvisionedConcurrencyConfigsCommand.d.ts +33 -0
  33. package/dist-types/commands/ListTagsCommand.d.ts +19 -0
  34. package/dist-types/commands/ListVersionsByFunctionCommand.d.ts +67 -0
  35. package/dist-types/commands/PublishLayerVersionCommand.d.ts +40 -0
  36. package/dist-types/commands/PublishVersionCommand.d.ts +42 -0
  37. package/dist-types/commands/PutFunctionConcurrencyCommand.d.ts +17 -0
  38. package/dist-types/commands/PutFunctionEventInvokeConfigCommand.d.ts +25 -0
  39. package/dist-types/commands/PutProvisionedConcurrencyConfigCommand.d.ts +21 -0
  40. package/dist-types/commands/RemoveLayerVersionPermissionCommand.d.ts +13 -0
  41. package/dist-types/commands/RemovePermissionCommand.d.ts +13 -0
  42. package/dist-types/commands/TagResourceCommand.d.ts +14 -0
  43. package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
  44. package/dist-types/commands/UpdateAliasCommand.d.ts +32 -0
  45. package/dist-types/commands/UpdateEventSourceMappingCommand.d.ts +26 -0
  46. package/dist-types/commands/UpdateFunctionCodeCommand.d.ts +33 -0
  47. package/dist-types/commands/UpdateFunctionConfigurationCommand.d.ts +32 -0
  48. package/dist-types/commands/UpdateFunctionEventInvokeConfigCommand.d.ts +30 -0
  49. package/package.json +5 -5
@@ -98,6 +98,27 @@ declare const AddLayerVersionPermissionCommand_base: {
98
98
  * <p>Base exception class for all service exceptions from Lambda service.</p>
99
99
  *
100
100
  * @public
101
+ * @example To add permissions to a layer version
102
+ * ```javascript
103
+ * // The following example grants permission for the account 223456789012 to use version 1 of a layer named my-layer.
104
+ * const input = {
105
+ * "Action": "lambda:GetLayerVersion",
106
+ * "LayerName": "my-layer",
107
+ * "Principal": "223456789012",
108
+ * "StatementId": "xaccount",
109
+ * "VersionNumber": 1
110
+ * };
111
+ * const command = new AddLayerVersionPermissionCommand(input);
112
+ * const response = await client.send(command);
113
+ * /* response ==
114
+ * {
115
+ * "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c",
116
+ * "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1\"}"
117
+ * }
118
+ * *\/
119
+ * // example id: to-add-permissions-to-a-layer-version-1586479797163
120
+ * ```
121
+ *
101
122
  */
102
123
  export declare class AddLayerVersionPermissionCommand extends AddLayerVersionPermissionCommand_base {
103
124
  /** @internal type navigation helper, not in runtime. */
@@ -113,6 +113,46 @@ declare const AddPermissionCommand_base: {
113
113
  * <p>Base exception class for all service exceptions from Lambda service.</p>
114
114
  *
115
115
  * @public
116
+ * @example To grant Amazon S3 permission to invoke a function
117
+ * ```javascript
118
+ * // The following example adds permission for Amazon S3 to invoke a Lambda function named my-function for notifications from a bucket named my-bucket-1xpuxmplzrlbh in account 123456789012.
119
+ * const input = {
120
+ * "Action": "lambda:InvokeFunction",
121
+ * "FunctionName": "my-function",
122
+ * "Principal": "s3.amazonaws.com",
123
+ * "SourceAccount": "123456789012",
124
+ * "SourceArn": "arn:aws:s3:::my-bucket-1xpuxmplzrlbh/*",
125
+ * "StatementId": "s3"
126
+ * };
127
+ * const command = new AddPermissionCommand(input);
128
+ * const response = await client.send(command);
129
+ * /* response ==
130
+ * {
131
+ * "Statement": "{\"Sid\":\"s3\",\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"s3.amazonaws.com\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\",\"Condition\":{\"StringEquals\":{\"AWS:SourceAccount\":\"123456789012\"},\"ArnLike\":{\"AWS:SourceArn\":\"arn:aws:s3:::my-bucket-1xpuxmplzrlbh\"}}}"
132
+ * }
133
+ * *\/
134
+ * // example id: add-permission-1474651469455
135
+ * ```
136
+ *
137
+ * @example To grant another account permission to invoke a function
138
+ * ```javascript
139
+ * // The following example adds permission for account 223456789012 invoke a Lambda function named my-function.
140
+ * const input = {
141
+ * "Action": "lambda:InvokeFunction",
142
+ * "FunctionName": "my-function",
143
+ * "Principal": "223456789012",
144
+ * "StatementId": "xaccount"
145
+ * };
146
+ * const command = new AddPermissionCommand(input);
147
+ * const response = await client.send(command);
148
+ * /* response ==
149
+ * {
150
+ * "Statement": "{\"Sid\":\"xaccount\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::223456789012:root\"},\"Action\":\"lambda:InvokeFunction\",\"Resource\":\"arn:aws:lambda:us-east-2:123456789012:function:my-function\"}"
151
+ * }
152
+ * *\/
153
+ * // example id: add-permission-1474651469456
154
+ * ```
155
+ *
116
156
  */
117
157
  export declare class AddPermissionCommand extends AddPermissionCommand_base {
118
158
  /** @internal type navigation helper, not in runtime. */
@@ -92,6 +92,29 @@ declare const CreateAliasCommand_base: {
92
92
  * <p>Base exception class for all service exceptions from Lambda service.</p>
93
93
  *
94
94
  * @public
95
+ * @example To create an alias for a Lambda function
96
+ * ```javascript
97
+ * // The following example creates an alias named LIVE that points to version 1 of the my-function Lambda function.
98
+ * const input = {
99
+ * "Description": "alias for live version of function",
100
+ * "FunctionName": "my-function",
101
+ * "FunctionVersion": "1",
102
+ * "Name": "LIVE"
103
+ * };
104
+ * const command = new CreateAliasCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response ==
107
+ * {
108
+ * "AliasArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:LIVE",
109
+ * "Description": "alias for live version of function",
110
+ * "FunctionVersion": "1",
111
+ * "Name": "LIVE",
112
+ * "RevisionId": "873282ed-xmpl-4dc8-a069-d0c647e470c6"
113
+ * }
114
+ * *\/
115
+ * // example id: to-create-an-alias-for-a-lambda-function-1586480324259
116
+ * ```
117
+ *
95
118
  */
96
119
  export declare class CreateAliasCommand extends CreateAliasCommand_base {
97
120
  /** @internal type navigation helper, not in runtime. */
@@ -321,6 +321,30 @@ declare const CreateEventSourceMappingCommand_base: {
321
321
  * <p>Base exception class for all service exceptions from Lambda service.</p>
322
322
  *
323
323
  * @public
324
+ * @example To create a mapping between an event source and an AWS Lambda function
325
+ * ```javascript
326
+ * // The following example creates a mapping between an SQS queue and the my-function Lambda function.
327
+ * const input = {
328
+ * "BatchSize": 5,
329
+ * "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue",
330
+ * "FunctionName": "my-function"
331
+ * };
332
+ * const command = new CreateEventSourceMappingCommand(input);
333
+ * const response = await client.send(command);
334
+ * /* response ==
335
+ * {
336
+ * "BatchSize": 5,
337
+ * "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue",
338
+ * "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
339
+ * "LastModified": 1569284520.333,
340
+ * "State": "Creating",
341
+ * "StateTransitionReason": "USER_INITIATED",
342
+ * "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
343
+ * }
344
+ * *\/
345
+ * // example id: to-create-a-mapping-between-an-event-source-and-an-aws-lambda-function-1586480555467
346
+ * ```
347
+ *
324
348
  */
325
349
  export declare class CreateEventSourceMappingCommand extends CreateEventSourceMappingCommand_base {
326
350
  /** @internal type navigation helper, not in runtime. */
@@ -294,6 +294,70 @@ declare const CreateFunctionCommand_base: {
294
294
  * <p>Base exception class for all service exceptions from Lambda service.</p>
295
295
  *
296
296
  * @public
297
+ * @example To create a function
298
+ * ```javascript
299
+ * // The following example creates a function with a deployment package in Amazon S3 and enables X-Ray tracing and environment variable encryption.
300
+ * const input = {
301
+ * "Code": {
302
+ * "S3Bucket": "my-bucket-1xpuxmplzrlbh",
303
+ * "S3Key": "function.zip"
304
+ * },
305
+ * "Description": "Process image objects from Amazon S3.",
306
+ * "Environment": {
307
+ * "Variables": {
308
+ * "BUCKET": "my-bucket-1xpuxmplzrlbh",
309
+ * "PREFIX": "inbound"
310
+ * }
311
+ * },
312
+ * "FunctionName": "my-function",
313
+ * "Handler": "index.handler",
314
+ * "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
315
+ * "MemorySize": 256,
316
+ * "Publish": true,
317
+ * "Role": "arn:aws:iam::123456789012:role/lambda-role",
318
+ * "Runtime": "nodejs12.x",
319
+ * "Tags": {
320
+ * "DEPARTMENT": "Assets"
321
+ * },
322
+ * "Timeout": 15,
323
+ * "TracingConfig": {
324
+ * "Mode": "Active"
325
+ * }
326
+ * };
327
+ * const command = new CreateFunctionCommand(input);
328
+ * const response = await client.send(command);
329
+ * /* response ==
330
+ * {
331
+ * "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=",
332
+ * "CodeSize": 5797206,
333
+ * "Description": "Process image objects from Amazon S3.",
334
+ * "Environment": {
335
+ * "Variables": {
336
+ * "BUCKET": "my-bucket-1xpuxmplzrlbh",
337
+ * "PREFIX": "inbound"
338
+ * }
339
+ * },
340
+ * "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
341
+ * "FunctionName": "my-function",
342
+ * "Handler": "index.handler",
343
+ * "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
344
+ * "LastModified": "2020-04-10T19:06:32.563+0000",
345
+ * "LastUpdateStatus": "Successful",
346
+ * "MemorySize": 256,
347
+ * "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727",
348
+ * "Role": "arn:aws:iam::123456789012:role/lambda-role",
349
+ * "Runtime": "nodejs12.x",
350
+ * "State": "Active",
351
+ * "Timeout": 15,
352
+ * "TracingConfig": {
353
+ * "Mode": "Active"
354
+ * },
355
+ * "Version": "1"
356
+ * }
357
+ * *\/
358
+ * // example id: to-create-a-function-1586492061186
359
+ * ```
360
+ *
297
361
  */
298
362
  export declare class CreateFunctionCommand extends CreateFunctionCommand_base {
299
363
  /** @internal type navigation helper, not in runtime. */
@@ -66,6 +66,18 @@ declare const DeleteAliasCommand_base: {
66
66
  * <p>Base exception class for all service exceptions from Lambda service.</p>
67
67
  *
68
68
  * @public
69
+ * @example To delete a Lambda function alias
70
+ * ```javascript
71
+ * // The following example deletes an alias named BLUE from a function named my-function
72
+ * const input = {
73
+ * "FunctionName": "my-function",
74
+ * "Name": "BLUE"
75
+ * };
76
+ * const command = new DeleteAliasCommand(input);
77
+ * await client.send(command);
78
+ * // example id: to-delete-a-lambda-function-alias-1481660370804
79
+ * ```
80
+ *
69
81
  */
70
82
  export declare class DeleteAliasCommand extends DeleteAliasCommand_base {
71
83
  /** @internal type navigation helper, not in runtime. */
@@ -149,6 +149,28 @@ declare const DeleteEventSourceMappingCommand_base: {
149
149
  * <p>Base exception class for all service exceptions from Lambda service.</p>
150
150
  *
151
151
  * @public
152
+ * @example To delete a Lambda function event source mapping
153
+ * ```javascript
154
+ * // The following example deletes an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.
155
+ * const input = {
156
+ * "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2"
157
+ * };
158
+ * const command = new DeleteEventSourceMappingCommand(input);
159
+ * const response = await client.send(command);
160
+ * /* response ==
161
+ * {
162
+ * "BatchSize": 5,
163
+ * "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:my-queue",
164
+ * "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function",
165
+ * "LastModified": "${timestamp}",
166
+ * "State": "Enabled",
167
+ * "StateTransitionReason": "USER_INITIATED",
168
+ * "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2"
169
+ * }
170
+ * *\/
171
+ * // example id: to-delete-a-lambda-function-event-source-mapping-1481658973862
172
+ * ```
173
+ *
152
174
  */
153
175
  export declare class DeleteEventSourceMappingCommand extends DeleteEventSourceMappingCommand_base {
154
176
  /** @internal type navigation helper, not in runtime. */
@@ -73,6 +73,18 @@ declare const DeleteFunctionCommand_base: {
73
73
  * <p>Base exception class for all service exceptions from Lambda service.</p>
74
74
  *
75
75
  * @public
76
+ * @example To delete a version of a Lambda function
77
+ * ```javascript
78
+ * // The following example deletes version 1 of a Lambda function named my-function.
79
+ * const input = {
80
+ * "FunctionName": "my-function",
81
+ * "Qualifier": "1"
82
+ * };
83
+ * const command = new DeleteFunctionCommand(input);
84
+ * await client.send(command);
85
+ * // example id: to-delete-a-lambda-function-1481648553696
86
+ * ```
87
+ *
76
88
  */
77
89
  export declare class DeleteFunctionCommand extends DeleteFunctionCommand_base {
78
90
  /** @internal type navigation helper, not in runtime. */
@@ -68,6 +68,17 @@ declare const DeleteFunctionConcurrencyCommand_base: {
68
68
  * <p>Base exception class for all service exceptions from Lambda service.</p>
69
69
  *
70
70
  * @public
71
+ * @example To remove the reserved concurrent execution limit from a function
72
+ * ```javascript
73
+ * // The following example deletes the reserved concurrent execution limit from a function named my-function.
74
+ * const input = {
75
+ * "FunctionName": "my-function"
76
+ * };
77
+ * const command = new DeleteFunctionConcurrencyCommand(input);
78
+ * await client.send(command);
79
+ * // example id: to-remove-the-reserved-concurrent-execution-limit-from-a-function-1586480714680
80
+ * ```
81
+ *
71
82
  */
72
83
  export declare class DeleteFunctionConcurrencyCommand extends DeleteFunctionConcurrencyCommand_base {
73
84
  /** @internal type navigation helper, not in runtime. */
@@ -70,6 +70,18 @@ declare const DeleteFunctionEventInvokeConfigCommand_base: {
70
70
  * <p>Base exception class for all service exceptions from Lambda service.</p>
71
71
  *
72
72
  * @public
73
+ * @example To delete an asynchronous invocation configuration
74
+ * ```javascript
75
+ * // The following example deletes the asynchronous invocation configuration for the GREEN alias of a function named my-function.
76
+ * const input = {
77
+ * "FunctionName": "my-function",
78
+ * "Qualifier": "GREEN"
79
+ * };
80
+ * const command = new DeleteFunctionEventInvokeConfigCommand(input);
81
+ * await client.send(command);
82
+ * // example id: to-delete-an-asynchronous-invocation-configuration-1586481102187
83
+ * ```
84
+ *
73
85
  */
74
86
  export declare class DeleteFunctionEventInvokeConfigCommand extends DeleteFunctionEventInvokeConfigCommand_base {
75
87
  /** @internal type navigation helper, not in runtime. */
@@ -62,6 +62,18 @@ declare const DeleteLayerVersionCommand_base: {
62
62
  * <p>Base exception class for all service exceptions from Lambda service.</p>
63
63
  *
64
64
  * @public
65
+ * @example To delete a version of a Lambda layer
66
+ * ```javascript
67
+ * // The following example deletes version 2 of a layer named my-layer.
68
+ * const input = {
69
+ * "LayerName": "my-layer",
70
+ * "VersionNumber": 2
71
+ * };
72
+ * const command = new DeleteLayerVersionCommand(input);
73
+ * await client.send(command);
74
+ * // example id: to-delete-a-version-of-a-lambda-layer-1586481157547
75
+ * ```
76
+ *
65
77
  */
66
78
  export declare class DeleteLayerVersionCommand extends DeleteLayerVersionCommand_base {
67
79
  /** @internal type navigation helper, not in runtime. */
@@ -69,6 +69,18 @@ declare const DeleteProvisionedConcurrencyConfigCommand_base: {
69
69
  * <p>Base exception class for all service exceptions from Lambda service.</p>
70
70
  *
71
71
  * @public
72
+ * @example To delete a provisioned concurrency configuration
73
+ * ```javascript
74
+ * // The following example deletes the provisioned concurrency configuration for the GREEN alias of a function named my-function.
75
+ * const input = {
76
+ * "FunctionName": "my-function",
77
+ * "Qualifier": "GREEN"
78
+ * };
79
+ * const command = new DeleteProvisionedConcurrencyConfigCommand(input);
80
+ * await client.send(command);
81
+ * // example id: to-delete-a-provisioned-concurrency-configuration-1586481032551
82
+ * ```
83
+ *
72
84
  */
73
85
  export declare class DeleteProvisionedConcurrencyConfigCommand extends DeleteProvisionedConcurrencyConfigCommand_base {
74
86
  /** @internal type navigation helper, not in runtime. */
@@ -69,6 +69,30 @@ declare const GetAccountSettingsCommand_base: {
69
69
  * <p>Base exception class for all service exceptions from Lambda service.</p>
70
70
  *
71
71
  * @public
72
+ * @example To get account settings
73
+ * ```javascript
74
+ * // This operation takes no parameters and returns details about storage and concurrency quotas in the current Region.
75
+ * const input = {};
76
+ * const command = new GetAccountSettingsCommand(input);
77
+ * const response = await client.send(command);
78
+ * /* response ==
79
+ * {
80
+ * "AccountLimit": {
81
+ * "CodeSizeUnzipped": 262144000,
82
+ * "CodeSizeZipped": 52428800,
83
+ * "ConcurrentExecutions": 1000,
84
+ * "TotalCodeSize": 80530636800,
85
+ * "UnreservedConcurrentExecutions": 1000
86
+ * },
87
+ * "AccountUsage": {
88
+ * "FunctionCount": 4,
89
+ * "TotalCodeSize": 9426
90
+ * }
91
+ * }
92
+ * *\/
93
+ * // example id: to-get-account-settings-1481657495274
94
+ * ```
95
+ *
72
96
  */
73
97
  export declare class GetAccountSettingsCommand extends GetAccountSettingsCommand_base {
74
98
  /** @internal type navigation helper, not in runtime. */
@@ -77,6 +77,27 @@ declare const GetAliasCommand_base: {
77
77
  * <p>Base exception class for all service exceptions from Lambda service.</p>
78
78
  *
79
79
  * @public
80
+ * @example To get a Lambda function alias
81
+ * ```javascript
82
+ * // The following example returns details about an alias named BLUE for a function named my-function
83
+ * const input = {
84
+ * "FunctionName": "my-function",
85
+ * "Name": "BLUE"
86
+ * };
87
+ * const command = new GetAliasCommand(input);
88
+ * const response = await client.send(command);
89
+ * /* response ==
90
+ * {
91
+ * "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BLUE",
92
+ * "Description": "Production environment BLUE.",
93
+ * "FunctionVersion": "3",
94
+ * "Name": "BLUE",
95
+ * "RevisionId": "594f41fb-xmpl-4c20-95c7-6ca5f2a92c93"
96
+ * }
97
+ * *\/
98
+ * // example id: to-retrieve-a-lambda-function-alias-1481648742254
99
+ * ```
100
+ *
80
101
  */
81
102
  export declare class GetAliasCommand extends GetAliasCommand_base {
82
103
  /** @internal type navigation helper, not in runtime. */
@@ -140,6 +140,33 @@ declare const GetEventSourceMappingCommand_base: {
140
140
  * <p>Base exception class for all service exceptions from Lambda service.</p>
141
141
  *
142
142
  * @public
143
+ * @example To get a Lambda function's event source mapping
144
+ * ```javascript
145
+ * // The following example returns details about an event source mapping. To get a mapping's UUID, use ListEventSourceMappings.
146
+ * const input = {
147
+ * "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2"
148
+ * };
149
+ * const command = new GetEventSourceMappingCommand(input);
150
+ * const response = await client.send(command);
151
+ * /* response ==
152
+ * {
153
+ * "BatchSize": 500,
154
+ * "BisectBatchOnFunctionError": false,
155
+ * "DestinationConfig": {},
156
+ * "EventSourceArn": "arn:aws:sqs:us-east-2:123456789012:mySQSqueue",
157
+ * "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:myFunction",
158
+ * "LastModified": "${timestamp}",
159
+ * "LastProcessingResult": "No records processed",
160
+ * "MaximumRecordAgeInSeconds": 604800,
161
+ * "MaximumRetryAttempts": 10000,
162
+ * "State": "Creating",
163
+ * "StateTransitionReason": "User action",
164
+ * "UUID": "14e0db71-xmpl-4eb5-b481-8945cf9d10c2"
165
+ * }
166
+ * *\/
167
+ * // example id: to-get-a-lambda-functions-event-source-mapping-1481661622799
168
+ * ```
169
+ *
143
170
  */
144
171
  export declare class GetEventSourceMappingCommand extends GetEventSourceMappingCommand_base {
145
172
  /** @internal type navigation helper, not in runtime. */
@@ -184,6 +184,56 @@ declare const GetFunctionCommand_base: {
184
184
  * <p>Base exception class for all service exceptions from Lambda service.</p>
185
185
  *
186
186
  * @public
187
+ * @example To get a Lambda function
188
+ * ```javascript
189
+ * // The following example returns code and configuration details for version 1 of a function named my-function.
190
+ * const input = {
191
+ * "FunctionName": "my-function",
192
+ * "Qualifier": "1"
193
+ * };
194
+ * const command = new GetFunctionCommand(input);
195
+ * const response = await client.send(command);
196
+ * /* response ==
197
+ * {
198
+ * "Code": {
199
+ * "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function-e7d9d1ed-xmpl-4f79-904a-4b87f2681f30?versionId=sH3TQwBOaUy...",
200
+ * "RepositoryType": "S3"
201
+ * },
202
+ * "Configuration": {
203
+ * "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=",
204
+ * "CodeSize": 5797206,
205
+ * "Description": "Process image objects from Amazon S3.",
206
+ * "Environment": {
207
+ * "Variables": {
208
+ * "BUCKET": "my-bucket-1xpuxmplzrlbh",
209
+ * "PREFIX": "inbound"
210
+ * }
211
+ * },
212
+ * "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
213
+ * "FunctionName": "my-function",
214
+ * "Handler": "index.handler",
215
+ * "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
216
+ * "LastModified": "2020-04-10T19:06:32.563+0000",
217
+ * "LastUpdateStatus": "Successful",
218
+ * "MemorySize": 256,
219
+ * "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727",
220
+ * "Role": "arn:aws:iam::123456789012:role/lambda-role",
221
+ * "Runtime": "nodejs12.x",
222
+ * "State": "Active",
223
+ * "Timeout": 15,
224
+ * "TracingConfig": {
225
+ * "Mode": "Active"
226
+ * },
227
+ * "Version": "$LATEST"
228
+ * },
229
+ * "Tags": {
230
+ * "DEPARTMENT": "Assets"
231
+ * }
232
+ * }
233
+ * *\/
234
+ * // example id: to-get-a-lambda-function-1481661622799
235
+ * ```
236
+ *
187
237
  */
188
238
  export declare class GetFunctionCommand extends GetFunctionCommand_base {
189
239
  /** @internal type navigation helper, not in runtime. */
@@ -68,6 +68,22 @@ declare const GetFunctionConcurrencyCommand_base: {
68
68
  * <p>Base exception class for all service exceptions from Lambda service.</p>
69
69
  *
70
70
  * @public
71
+ * @example To get the reserved concurrency setting for a function
72
+ * ```javascript
73
+ * // The following example returns the reserved concurrency setting for a function named my-function.
74
+ * const input = {
75
+ * "FunctionName": "my-function"
76
+ * };
77
+ * const command = new GetFunctionConcurrencyCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response ==
80
+ * {
81
+ * "ReservedConcurrentExecutions": 250
82
+ * }
83
+ * *\/
84
+ * // example id: to-get-the-reserved-concurrency-setting-for-a-function-1586481279992
85
+ * ```
86
+ *
71
87
  */
72
88
  export declare class GetFunctionConcurrencyCommand extends GetFunctionConcurrencyCommand_base {
73
89
  /** @internal type navigation helper, not in runtime. */
@@ -170,6 +170,47 @@ declare const GetFunctionConfigurationCommand_base: {
170
170
  * <p>Base exception class for all service exceptions from Lambda service.</p>
171
171
  *
172
172
  * @public
173
+ * @example To get a Lambda function's event source mapping
174
+ * ```javascript
175
+ * // The following example returns and configuration details for version 1 of a function named my-function.
176
+ * const input = {
177
+ * "FunctionName": "my-function",
178
+ * "Qualifier": "1"
179
+ * };
180
+ * const command = new GetFunctionConfigurationCommand(input);
181
+ * const response = await client.send(command);
182
+ * /* response ==
183
+ * {
184
+ * "CodeSha256": "YFgDgEKG3ugvF1+pX64gV6tu9qNuIYNUdgJm8nCxsm4=",
185
+ * "CodeSize": 5797206,
186
+ * "Description": "Process image objects from Amazon S3.",
187
+ * "Environment": {
188
+ * "Variables": {
189
+ * "BUCKET": "my-bucket-1xpuxmplzrlbh",
190
+ * "PREFIX": "inbound"
191
+ * }
192
+ * },
193
+ * "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function",
194
+ * "FunctionName": "my-function",
195
+ * "Handler": "index.handler",
196
+ * "KMSKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b0844d6c-xmpl-4463-97a4-d49f50839966",
197
+ * "LastModified": "2020-04-10T19:06:32.563+0000",
198
+ * "LastUpdateStatus": "Successful",
199
+ * "MemorySize": 256,
200
+ * "RevisionId": "b75dcd81-xmpl-48a8-a75a-93ba8b5b9727",
201
+ * "Role": "arn:aws:iam::123456789012:role/lambda-role",
202
+ * "Runtime": "nodejs12.x",
203
+ * "State": "Active",
204
+ * "Timeout": 15,
205
+ * "TracingConfig": {
206
+ * "Mode": "Active"
207
+ * },
208
+ * "Version": "$LATEST"
209
+ * }
210
+ * *\/
211
+ * // example id: to-get-a-lambda-functions-event-source-mapping-1481661622799
212
+ * ```
213
+ *
173
214
  */
174
215
  export declare class GetFunctionConfigurationCommand extends GetFunctionConfigurationCommand_base {
175
216
  /** @internal type navigation helper, not in runtime. */
@@ -80,6 +80,32 @@ declare const GetFunctionEventInvokeConfigCommand_base: {
80
80
  * <p>Base exception class for all service exceptions from Lambda service.</p>
81
81
  *
82
82
  * @public
83
+ * @example To get an asynchronous invocation configuration
84
+ * ```javascript
85
+ * // The following example returns the asynchronous invocation configuration for the BLUE alias of a function named my-function.
86
+ * const input = {
87
+ * "FunctionName": "my-function",
88
+ * "Qualifier": "BLUE"
89
+ * };
90
+ * const command = new GetFunctionEventInvokeConfigCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response ==
93
+ * {
94
+ * "DestinationConfig": {
95
+ * "OnFailure": {
96
+ * "Destination": "arn:aws:sqs:us-east-2:123456789012:failed-invocations"
97
+ * },
98
+ * "OnSuccess": {}
99
+ * },
100
+ * "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:BLUE",
101
+ * "LastModified": "${timestamp}",
102
+ * "MaximumEventAgeInSeconds": 3600,
103
+ * "MaximumRetryAttempts": 0
104
+ * }
105
+ * *\/
106
+ * // example id: to-get-an-asynchronous-invocation-configuration-1586481338463
107
+ * ```
108
+ *
83
109
  */
84
110
  export declare class GetFunctionEventInvokeConfigCommand extends GetFunctionEventInvokeConfigCommand_base {
85
111
  /** @internal type navigation helper, not in runtime. */
@@ -87,6 +87,34 @@ declare const GetLayerVersionByArnCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from Lambda service.</p>
88
88
  *
89
89
  * @public
90
+ * @example To get information about a Lambda layer version
91
+ * ```javascript
92
+ * // The following example returns information about the layer version with the specified Amazon Resource Name (ARN).
93
+ * const input = {
94
+ * "Arn": "arn:aws:lambda:ca-central-1:123456789012:layer:blank-python-lib:3"
95
+ * };
96
+ * const command = new GetLayerVersionByArnCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "CompatibleRuntimes": [
101
+ * "python3.8"
102
+ * ],
103
+ * "Content": {
104
+ * "CodeSha256": "6x+xmpl/M3BnQUk7gS9sGmfeFsR/npojXoA3fZUv4eU=",
105
+ * "CodeSize": 9529009,
106
+ * "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/blank-python-lib-e5212378-xmpl-44ee-8398-9d8ec5113949?versionId=WbZnvf..."
107
+ * },
108
+ * "CreatedDate": "2020-03-31T00:35:18.949+0000",
109
+ * "Description": "Dependencies for the blank-python sample app.",
110
+ * "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib",
111
+ * "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:blank-python-lib:3",
112
+ * "Version": 3
113
+ * }
114
+ * *\/
115
+ * // example id: to-get-information-about-a-lambda-layer-version-1586481457839
116
+ * ```
117
+ *
90
118
  */
91
119
  export declare class GetLayerVersionByArnCommand extends GetLayerVersionByArnCommand_base {
92
120
  /** @internal type navigation helper, not in runtime. */