@Generated(value="software.amazon.awssdk:codegen") public interface LambdaAsyncClient extends SdkClient, SdkAutoCloseable
builder()
method.
Overview
This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AddPermissionResponse> |
addPermission(AddPermissionRequest addPermissionRequest)
Adds a permission to the resource policy associated with the specified AWS Lambda function.
|
default CompletableFuture<AddPermissionResponse> |
addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
Adds a permission to the resource policy associated with the specified AWS Lambda function.
|
static LambdaAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
LambdaAsyncClient . |
static LambdaAsyncClient |
create()
Create a
LambdaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default CompletableFuture<CreateAliasResponse> |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates an alias that points to the specified Lambda function version.
|
default CompletableFuture<CreateAliasResponse> |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias that points to the specified Lambda function version.
|
default CompletableFuture<CreateEventSourceMappingResponse> |
createEventSourceMapping(Consumer<CreateEventSourceMappingRequest.Builder> createEventSourceMappingRequest)
Identifies a stream as an event source for a Lambda function.
|
default CompletableFuture<CreateEventSourceMappingResponse> |
createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
Identifies a stream as an event source for a Lambda function.
|
default CompletableFuture<CreateFunctionResponse> |
createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest)
Creates a new Lambda function.
|
default CompletableFuture<CreateFunctionResponse> |
createFunction(CreateFunctionRequest createFunctionRequest)
Creates a new Lambda function.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes the specified Lambda function alias.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias.
|
default CompletableFuture<DeleteEventSourceMappingResponse> |
deleteEventSourceMapping(Consumer<DeleteEventSourceMappingRequest.Builder> deleteEventSourceMappingRequest)
Removes an event source mapping.
|
default CompletableFuture<DeleteEventSourceMappingResponse> |
deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
Removes an event source mapping.
|
default CompletableFuture<DeleteFunctionResponse> |
deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest)
Deletes the specified Lambda function code and configuration.
|
default CompletableFuture<DeleteFunctionResponse> |
deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
Deletes the specified Lambda function code and configuration.
|
default CompletableFuture<DeleteFunctionConcurrencyResponse> |
deleteFunctionConcurrency(Consumer<DeleteFunctionConcurrencyRequest.Builder> deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function.
|
default CompletableFuture<DeleteFunctionConcurrencyResponse> |
deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings()
Returns a customer's account settings.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Returns a customer's account settings.
|
default CompletableFuture<GetAccountSettingsResponse> |
getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns a customer's account settings.
|
default CompletableFuture<GetAliasResponse> |
getAlias(Consumer<GetAliasRequest.Builder> getAliasRequest)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing
to.
|
default CompletableFuture<GetAliasResponse> |
getAlias(GetAliasRequest getAliasRequest)
Returns the specified alias information such as the alias ARN, description, and function version it is pointing
to.
|
default CompletableFuture<GetEventSourceMappingResponse> |
getEventSourceMapping(Consumer<GetEventSourceMappingRequest.Builder> getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
|
default CompletableFuture<GetEventSourceMappingResponse> |
getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
|
default CompletableFuture<GetFunctionResponse> |
getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest)
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.
|
default CompletableFuture<GetFunctionResponse> |
getFunction(GetFunctionRequest getFunctionRequest)
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.
|
default CompletableFuture<GetFunctionConfigurationResponse> |
getFunctionConfiguration(Consumer<GetFunctionConfigurationRequest.Builder> getFunctionConfigurationRequest)
Returns the configuration information of the Lambda function.
|
default CompletableFuture<GetFunctionConfigurationResponse> |
getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
Returns the configuration information of the Lambda function.
|
default CompletableFuture<GetPolicyResponse> |
getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
Returns the resource policy associated with the specified Lambda function.
|
default CompletableFuture<GetPolicyResponse> |
getPolicy(GetPolicyRequest getPolicyRequest)
Returns the resource policy associated with the specified Lambda function.
|
default CompletableFuture<InvokeResponse> |
invoke(Consumer<InvokeRequest.Builder> invokeRequest)
Invokes a specific Lambda function.
|
default CompletableFuture<InvokeResponse> |
invoke(InvokeRequest invokeRequest)
Invokes a specific Lambda function.
|
default CompletableFuture<InvokeAsyncResponse> |
invokeAsync(InvokeAsyncRequest invokeAsyncRequest,
AsyncRequestProvider requestProvider)
|
default CompletableFuture<InvokeAsyncResponse> |
invokeAsync(InvokeAsyncRequest invokeAsyncRequest,
Path path)
|
default CompletableFuture<ListAliasesResponse> |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Returns list of aliases created for a Lambda function.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(ListAliasesRequest listAliasesRequest)
Returns list of aliases created for a Lambda function.
|
default CompletableFuture<ListEventSourceMappingsResponse> |
listEventSourceMappings()
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
default CompletableFuture<ListEventSourceMappingsResponse> |
listEventSourceMappings(Consumer<ListEventSourceMappingsRequest.Builder> listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
default CompletableFuture<ListEventSourceMappingsResponse> |
listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
default ListEventSourceMappingsPublisher |
listEventSourceMappingsPaginator()
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
default ListEventSourceMappingsPublisher |
listEventSourceMappingsPaginator(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
Returns a list of event source mappings you created using the
CreateEventSourceMapping (see
CreateEventSourceMapping). |
default CompletableFuture<ListFunctionsResponse> |
listFunctions()
Returns a list of your Lambda functions.
|
default CompletableFuture<ListFunctionsResponse> |
listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest)
Returns a list of your Lambda functions.
|
default CompletableFuture<ListFunctionsResponse> |
listFunctions(ListFunctionsRequest listFunctionsRequest)
Returns a list of your Lambda functions.
|
default ListFunctionsPublisher |
listFunctionsPaginator()
Returns a list of your Lambda functions.
|
default ListFunctionsPublisher |
listFunctionsPaginator(ListFunctionsRequest listFunctionsRequest)
Returns a list of your Lambda functions.
|
default CompletableFuture<ListTagsResponse> |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
|
default CompletableFuture<ListTagsResponse> |
listTags(ListTagsRequest listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
|
default CompletableFuture<ListVersionsByFunctionResponse> |
listVersionsByFunction(Consumer<ListVersionsByFunctionRequest.Builder> listVersionsByFunctionRequest)
List all versions of a function.
|
default CompletableFuture<ListVersionsByFunctionResponse> |
listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
List all versions of a function.
|
default CompletableFuture<PublishVersionResponse> |
publishVersion(Consumer<PublishVersionRequest.Builder> publishVersionRequest)
Publishes a version of your function from the current snapshot of $LATEST.
|
default CompletableFuture<PublishVersionResponse> |
publishVersion(PublishVersionRequest publishVersionRequest)
Publishes a version of your function from the current snapshot of $LATEST.
|
default CompletableFuture<PutFunctionConcurrencyResponse> |
putFunctionConcurrency(Consumer<PutFunctionConcurrencyRequest.Builder> putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function.
|
default CompletableFuture<PutFunctionConcurrencyResponse> |
putFunctionConcurrency(PutFunctionConcurrencyRequest putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
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.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(RemovePermissionRequest removePermissionRequest)
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.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a Lambda function.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a Lambda function.
|
default CompletableFuture<UpdateAliasResponse> |
updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
Using this API you can update the function version to which the alias points and the alias description.
|
default CompletableFuture<UpdateAliasResponse> |
updateAlias(UpdateAliasRequest updateAliasRequest)
Using this API you can update the function version to which the alias points and the alias description.
|
default CompletableFuture<UpdateEventSourceMappingResponse> |
updateEventSourceMapping(Consumer<UpdateEventSourceMappingRequest.Builder> updateEventSourceMappingRequest)
You can update an event source mapping.
|
default CompletableFuture<UpdateEventSourceMappingResponse> |
updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
You can update an event source mapping.
|
default CompletableFuture<UpdateFunctionCodeResponse> |
updateFunctionCode(Consumer<UpdateFunctionCodeRequest.Builder> updateFunctionCodeRequest)
Updates the code for the specified Lambda function.
|
default CompletableFuture<UpdateFunctionCodeResponse> |
updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
Updates the code for the specified Lambda function.
|
default CompletableFuture<UpdateFunctionConfigurationResponse> |
updateFunctionConfiguration(Consumer<UpdateFunctionConfigurationRequest.Builder> updateFunctionConfigurationRequest)
Updates the configuration parameters for the specified Lambda function by using the values provided in the
request.
|
default CompletableFuture<UpdateFunctionConfigurationResponse> |
updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
Updates the configuration parameters for the specified Lambda function by using the values provided in the
request.
|
serviceName
close
static final String SERVICE_NAME
static LambdaAsyncClient create()
LambdaAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static LambdaAsyncClientBuilder builder()
LambdaAsyncClient
.default CompletableFuture<AddPermissionResponse> addPermission(AddPermissionRequest addPermissionRequest)
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.
addPermissionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<AddPermissionResponse> addPermission(Consumer<AddPermissionRequest.Builder> addPermissionRequest)
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.
AddPermissionRequest.Builder
avoiding the need to
create one manually via AddPermissionRequest.builder()
addPermissionRequest
- a Consumer
that will call methods on AddPermissionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)
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.
createAliasRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
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.
CreateAliasRequest.Builder
avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest
- a Consumer
that will call methods on CreateAliasRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<CreateEventSourceMappingResponse> createEventSourceMapping(CreateEventSourceMappingRequest createEventSourceMappingRequest)
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, see 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.
createEventSourceMappingRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<CreateEventSourceMappingResponse> createEventSourceMapping(Consumer<CreateEventSourceMappingRequest.Builder> createEventSourceMappingRequest)
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, see 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.
CreateEventSourceMappingRequest.Builder
avoiding
the need to create one manually via CreateEventSourceMappingRequest.builder()
createEventSourceMappingRequest
- a Consumer
that will call methods on CreateEventSourceMappingRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<CreateFunctionResponse> createFunction(CreateFunctionRequest createFunctionRequest)
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.
createFunctionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<CreateFunctionResponse> createFunction(Consumer<CreateFunctionRequest.Builder> createFunctionRequest)
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.
CreateFunctionRequest.Builder
avoiding the need to
create one manually via CreateFunctionRequest.builder()
createFunctionRequest
- a Consumer
that will call methods on CreateFunctionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
deleteAliasRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.
This requires permission for the lambda:DeleteAlias action.
DeleteAliasRequest.Builder
avoiding the need to
create one manually via DeleteAliasRequest.builder()
deleteAliasRequest
- a Consumer
that will call methods on DeleteAliasRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteEventSourceMappingResponse> deleteEventSourceMapping(DeleteEventSourceMappingRequest deleteEventSourceMappingRequest)
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.
deleteEventSourceMappingRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteEventSourceMappingResponse> deleteEventSourceMapping(Consumer<DeleteEventSourceMappingRequest.Builder> deleteEventSourceMappingRequest)
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.
DeleteEventSourceMappingRequest.Builder
avoiding
the need to create one manually via DeleteEventSourceMappingRequest.builder()
deleteEventSourceMappingRequest
- a Consumer
that will call methods on DeleteEventSourceMappingRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteFunctionResponse> deleteFunction(DeleteFunctionRequest deleteFunctionRequest)
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.
deleteFunctionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteFunctionResponse> deleteFunction(Consumer<DeleteFunctionRequest.Builder> deleteFunctionRequest)
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.
DeleteFunctionRequest.Builder
avoiding the need to
create one manually via DeleteFunctionRequest.builder()
deleteFunctionRequest
- a Consumer
that will call methods on DeleteFunctionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteFunctionConcurrencyResponse> deleteFunctionConcurrency(DeleteFunctionConcurrencyRequest deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function. For more information, see concurrent-executions.
deleteFunctionConcurrencyRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<DeleteFunctionConcurrencyResponse> deleteFunctionConcurrency(Consumer<DeleteFunctionConcurrencyRequest.Builder> deleteFunctionConcurrencyRequest)
Removes concurrent execution limits from this function. For more information, see concurrent-executions.
DeleteFunctionConcurrencyRequest.Builder
avoiding
the need to create one manually via DeleteFunctionConcurrencyRequest.builder()
deleteFunctionConcurrencyRequest
- a Consumer
that will call methods on DeleteFunctionConcurrencyRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
Returns a customer's account settings.
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.
getAccountSettingsRequest
- default CompletableFuture<GetAccountSettingsResponse> getAccountSettings()
Returns a customer's account settings.
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.
default CompletableFuture<GetAccountSettingsResponse> getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
Returns a customer's account settings.
You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.
GetAccountSettingsRequest.Builder
avoiding the
need to create one manually via GetAccountSettingsRequest.builder()
getAccountSettingsRequest
- a Consumer
that will call methods on GetAccountSettingsRequest.Builder
.default CompletableFuture<GetAliasResponse> getAlias(GetAliasRequest getAliasRequest)
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.
getAliasRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetAliasResponse> getAlias(Consumer<GetAliasRequest.Builder> getAliasRequest)
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.
GetAliasRequest.Builder
avoiding the need to
create one manually via GetAliasRequest.builder()
getAliasRequest
- a Consumer
that will call methods on GetAliasRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetEventSourceMappingResponse> getEventSourceMapping(GetEventSourceMappingRequest getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping
action.
getEventSourceMappingRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetEventSourceMappingResponse> getEventSourceMapping(Consumer<GetEventSourceMappingRequest.Builder> getEventSourceMappingRequest)
Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).
This operation requires permission for the lambda:GetEventSourceMapping
action.
GetEventSourceMappingRequest.Builder
avoiding the
need to create one manually via GetEventSourceMappingRequest.builder()
getEventSourceMappingRequest
- a Consumer
that will call methods on GetEventSourceMappingRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetFunctionResponse> getFunction(GetFunctionRequest getFunctionRequest)
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.
getFunctionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetFunctionResponse> getFunction(Consumer<GetFunctionRequest.Builder> getFunctionRequest)
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.
GetFunctionRequest.Builder
avoiding the need to
create one manually via GetFunctionRequest.builder()
getFunctionRequest
- a Consumer
that will call methods on GetFunctionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetFunctionConfigurationResponse> getFunctionConfiguration(GetFunctionConfigurationRequest getFunctionConfigurationRequest)
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.
getFunctionConfigurationRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetFunctionConfigurationResponse> getFunctionConfiguration(Consumer<GetFunctionConfigurationRequest.Builder> getFunctionConfigurationRequest)
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.
GetFunctionConfigurationRequest.Builder
avoiding
the need to create one manually via GetFunctionConfigurationRequest.builder()
getFunctionConfigurationRequest
- a Consumer
that will call methods on GetFunctionConfigurationRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetPolicyResponse> getPolicy(GetPolicyRequest getPolicyRequest)
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.
You need permission for the lambda:GetPolicy action.
getPolicyRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
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.
You need permission for the lambda:GetPolicy action.
GetPolicyRequest.Builder
avoiding the need to
create one manually via GetPolicyRequest.builder()
getPolicyRequest
- a Consumer
that will call methods on GetPolicyRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<InvokeResponse> invoke(InvokeRequest invokeRequest)
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.
The TooManyRequestsException
noted below will return the following:
ConcurrentInvocationLimitExceeded
will be returned if you have no functions with reserved
concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds
the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded
will
be returned when a function with reserved concurrency exceeds its configured concurrency limit.
invokeRequest
- Invoke
request body JSON input
limit. For more information, see Limits.Invoke
request body is not JSON.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<InvokeResponse> invoke(Consumer<InvokeRequest.Builder> invokeRequest)
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.
The TooManyRequestsException
noted below will return the following:
ConcurrentInvocationLimitExceeded
will be returned if you have no functions with reserved
concurrency and have exceeded your account concurrent limit or if a function without reserved concurrency exceeds
the account's unreserved concurrency limit. ReservedFunctionConcurrentInvocationLimitExceeded
will
be returned when a function with reserved concurrency exceeds its configured concurrency limit.
InvokeRequest.Builder
avoiding the need to create
one manually via InvokeRequest.builder()
invokeRequest
- a Consumer
that will call methods on InvocationRequest.Builder
.Invoke
request body JSON input
limit. For more information, see Limits.Invoke
request body is not JSON.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<InvokeAsyncResponse> invokeAsync(InvokeAsyncRequest invokeAsyncRequest, AsyncRequestProvider requestProvider)
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.
invokeAsyncRequest
- requestProvider
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestProvider
for specific
details on implementing this interface as well as links to precanned implementations for common scenarios
like uploading from a file. The service documentation for the request content is as follows '
JSON that you want to provide to your Lambda function as input.
'default CompletableFuture<InvokeAsyncResponse> invokeAsync(InvokeAsyncRequest invokeAsyncRequest, Path path)
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.
invokeAsyncRequest
- path
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
JSON that you want to provide to your Lambda function as input.
'default CompletableFuture<ListAliasesResponse> listAliases(ListAliasesRequest listAliasesRequest)
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.
listAliasesRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
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.
ListAliasesRequest.Builder
avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest
- a Consumer
that will call methods on ListAliasesRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListEventSourceMappingsResponse> listEventSourceMappings(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
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.
listEventSourceMappingsRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListEventSourceMappingsResponse> listEventSourceMappings()
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.
CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListEventSourceMappingsResponse> listEventSourceMappings(Consumer<ListEventSourceMappingsRequest.Builder> listEventSourceMappingsRequest)
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.
ListEventSourceMappingsRequest.Builder
avoiding
the need to create one manually via ListEventSourceMappingsRequest.builder()
listEventSourceMappingsRequest
- a Consumer
that will call methods on ListEventSourceMappingsRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default ListEventSourceMappingsPublisher listEventSourceMappingsPaginator(ListEventSourceMappingsRequest listEventSourceMappingsRequest)
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.
This is a variant of
listEventSourceMappings(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.lambda.paginators.ListEventSourceMappingsPublisher publisher = client.listEventSourceMappingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lambda.paginators.ListEventSourceMappingsPublisher publisher = client.listEventSourceMappingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listEventSourceMappings(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsRequest)
operation.
listEventSourceMappingsRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default ListEventSourceMappingsPublisher listEventSourceMappingsPaginator()
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.
This is a variant of
listEventSourceMappings(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.lambda.paginators.ListEventSourceMappingsPublisher publisher = client.listEventSourceMappingsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lambda.paginators.ListEventSourceMappingsPublisher publisher = client.listEventSourceMappingsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listEventSourceMappings(software.amazon.awssdk.services.lambda.model.ListEventSourceMappingsRequest)
operation.
CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListFunctionsResponse> listFunctions(ListFunctionsRequest listFunctionsRequest)
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 the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
listFunctionsRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListFunctionsResponse> listFunctions()
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 the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListFunctionsResponse> listFunctions(Consumer<ListFunctionsRequest.Builder> listFunctionsRequest)
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 the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
ListFunctionsRequest.Builder
avoiding the need to
create one manually via ListFunctionsRequest.builder()
listFunctionsRequest
- a Consumer
that will call methods on ListFunctionsRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default ListFunctionsPublisher listFunctionsPaginator(ListFunctionsRequest listFunctionsRequest)
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 the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
This is a variant of listFunctions(software.amazon.awssdk.services.lambda.model.ListFunctionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.lambda.paginators.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lambda.paginators.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lambda.model.ListFunctionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lambda.model.ListFunctionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listFunctions(software.amazon.awssdk.services.lambda.model.ListFunctionsRequest)
operation.
listFunctionsRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default ListFunctionsPublisher listFunctionsPaginator()
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 the versioning feature, you can list all of your functions or only $LATEST
versions. For information about the versioning feature, see AWS Lambda Function Versioning and
Aliases.
This is a variant of listFunctions(software.amazon.awssdk.services.lambda.model.ListFunctionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.lambda.paginators.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.lambda.paginators.ListFunctionsPublisher publisher = client.listFunctionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.lambda.model.ListFunctionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.lambda.model.ListFunctionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listFunctions(software.amazon.awssdk.services.lambda.model.ListFunctionsRequest)
operation.
CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
listTagsRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns a list of tags assigned to a function when supplied the function ARN (Amazon Resource Name).
ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- a Consumer
that will call methods on ListTagsRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListVersionsByFunctionResponse> listVersionsByFunction(ListVersionsByFunctionRequest listVersionsByFunctionRequest)
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
listVersionsByFunctionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<ListVersionsByFunctionResponse> listVersionsByFunction(Consumer<ListVersionsByFunctionRequest.Builder> listVersionsByFunctionRequest)
List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.
ListVersionsByFunctionRequest.Builder
avoiding the
need to create one manually via ListVersionsByFunctionRequest.builder()
listVersionsByFunctionRequest
- a Consumer
that will call methods on ListVersionsByFunctionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<PublishVersionResponse> publishVersion(PublishVersionRequest publishVersionRequest)
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.
publishVersionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<PublishVersionResponse> publishVersion(Consumer<PublishVersionRequest.Builder> publishVersionRequest)
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.
PublishVersionRequest.Builder
avoiding the need to
create one manually via PublishVersionRequest.builder()
publishVersionRequest
- a Consumer
that will call methods on PublishVersionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<PutFunctionConcurrencyResponse> putFunctionConcurrency(PutFunctionConcurrencyRequest putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see concurrent-executions.
putFunctionConcurrencyRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<PutFunctionConcurrencyResponse> putFunctionConcurrency(Consumer<PutFunctionConcurrencyRequest.Builder> putFunctionConcurrencyRequest)
Sets a limit on the number of concurrent executions available to this function. It is a subset of your account's total concurrent execution limit per region. Note that Lambda automatically reserves a buffer of 100 concurrent executions for functions without any reserved concurrency limit. This means if your account limit is 1000, you have a total of 900 available to allocate to individual functions. For more information, see concurrent-executions.
PutFunctionConcurrencyRequest.Builder
avoiding the
need to create one manually via PutFunctionConcurrencyRequest.builder()
putFunctionConcurrencyRequest
- a Consumer
that will call methods on PutFunctionConcurrencyRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)
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.
removePermissionRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
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.
RemovePermissionRequest.Builder
avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest
- a Consumer
that will call methods on RemovePermissionRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null.
tagResourceRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Creates a list of tags (key-value pairs) on the Lambda function. Requires the Lambda function ARN (Amazon Resource Name). If a key is specified without a value, Lambda creates a tag with the specified key and a value of null.
TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- a Consumer
that will call methods on TagResourceRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name).
untagResourceRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a Lambda function. Requires the function ARN (Amazon Resource Name).
UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- a Consumer
that will call methods on UntagResourceRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<UpdateAliasResponse> updateAlias(UpdateAliasRequest updateAliasRequest)
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.
updateAliasRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<UpdateAliasResponse> updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
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.
UpdateAliasRequest.Builder
avoiding the need to
create one manually via UpdateAliasRequest.builder()
updateAliasRequest
- a Consumer
that will call methods on UpdateAliasRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<UpdateEventSourceMappingResponse> updateEventSourceMapping(UpdateEventSourceMappingRequest updateEventSourceMappingRequest)
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.
updateEventSourceMappingRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<UpdateEventSourceMappingResponse> updateEventSourceMapping(Consumer<UpdateEventSourceMappingRequest.Builder> updateEventSourceMappingRequest)
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.
UpdateEventSourceMappingRequest.Builder
avoiding
the need to create one manually via UpdateEventSourceMappingRequest.builder()
updateEventSourceMappingRequest
- a Consumer
that will call methods on UpdateEventSourceMappingRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.default CompletableFuture<UpdateFunctionCodeResponse> updateFunctionCode(UpdateFunctionCodeRequest updateFunctionCodeRequest)
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.
updateFunctionCodeRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<UpdateFunctionCodeResponse> updateFunctionCode(Consumer<UpdateFunctionCodeRequest.Builder> updateFunctionCodeRequest)
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.
UpdateFunctionCodeRequest.Builder
avoiding the
need to create one manually via UpdateFunctionCodeRequest.builder()
updateFunctionCodeRequest
- a Consumer
that will call methods on UpdateFunctionCodeRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<UpdateFunctionConfigurationResponse> updateFunctionConfiguration(UpdateFunctionConfigurationRequest updateFunctionConfigurationRequest)
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.
updateFunctionConfigurationRequest
- CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.default CompletableFuture<UpdateFunctionConfigurationResponse> updateFunctionConfiguration(Consumer<UpdateFunctionConfigurationRequest.Builder> updateFunctionConfigurationRequest)
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.
UpdateFunctionConfigurationRequest.Builder
avoiding the need to create one manually via UpdateFunctionConfigurationRequest.builder()
updateFunctionConfigurationRequest
- a Consumer
that will call methods on UpdateFunctionConfigurationRequest.Builder
.CreateFunction
or the
UpdateFunctionConfiguration
API, that AWS Lambda is unable to assume you will get this
exception.GetFunction
or the GetAlias
API to retrieve
the latest RevisionId for your resource.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.