lambdaweb/aws.sdk.kotlin.services.lambdaweb/LambdaWebClient

LambdaWebClient

AWS Lambda Web Functions let you run web applications and APIs as HTTP servers on Lambda. A web function has one or more immutable revisions (code and configuration) and one or more endpoints that expose it over HTTPS.

Types

Builder

class Builder : AbstractSdkClientBuilder<LambdaWebClient.Config, LambdaWebClient.Config.Builder, LambdaWebClient>

Companion

object Companion : AbstractAwsSdkClientFactory<LambdaWebClient.Config, LambdaWebClient.Config.Builder, LambdaWebClient, LambdaWebClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, LogRedactionConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

config

abstract override val config: LambdaWebClient.Config

LambdaWebClient's configuration

Functions

createWebFunction

abstract suspend fun createWebFunction(input: CreateWebFunctionRequest): CreateWebFunctionResponse

Creates a web function with an initial revision and endpoint. To create a web function, you provide the function name, revision configuration (code and service settings), and endpoint configuration.

createWebFunctionEndpoint

abstract suspend fun createWebFunctionEndpoint(input: CreateWebFunctionEndpointRequest): CreateWebFunctionEndpointResponse

Creates an endpoint for a web function. An endpoint exposes the web function over HTTPS and routes traffic to one or more revisions.

createWebFunctionRevision

abstract suspend fun createWebFunctionRevision(input: CreateWebFunctionRevisionRequest): CreateWebFunctionRevisionResponse

Creates an immutable revision for a web function. A revision represents a specific version of the function code and configuration.

deleteResourcePolicy

abstract suspend fun deleteResourcePolicy(input: DeleteResourcePolicyRequest): DeleteResourcePolicyResponse

Removes the resource-based policy from a web function.

deleteWebFunction

abstract suspend fun deleteWebFunction(input: DeleteWebFunctionRequest): DeleteWebFunctionResponse

Deletes a web function and all of its associated revisions and endpoints.

deleteWebFunctionEndpoint

abstract suspend fun deleteWebFunctionEndpoint(input: DeleteWebFunctionEndpointRequest): DeleteWebFunctionEndpointResponse

Deletes a web function endpoint.

deleteWebFunctionRevision

abstract suspend fun deleteWebFunctionRevision(input: DeleteWebFunctionRevisionRequest): DeleteWebFunctionRevisionResponse

Deletes a web function revision. You cannot delete a revision that is currently serving traffic on an endpoint.

getResourcePolicy

abstract suspend fun getResourcePolicy(input: GetResourcePolicyRequest): GetResourcePolicyResponse

Retrieves the resource-based policy attached to a web function.

getWebAccountSettings

abstract suspend fun getWebAccountSettings(input: GetWebAccountSettingsRequest = GetWebAccountSettingsRequest { }): GetWebAccountSettingsResponse

Retrieves details about your AWS Lambda Web Functions account settings for the current AWS Region, including the quotas that apply to web functions and your current usage.

getWebFunction

abstract suspend fun getWebFunction(input: GetWebFunctionRequest): GetWebFunctionResponse

Retrieves details about a web function, including its current state and configuration.

getWebFunctionEndpoint

abstract suspend fun getWebFunctionEndpoint(input: GetWebFunctionEndpointRequest): GetWebFunctionEndpointResponse

Retrieves details about a web function endpoint, including its current state, configuration, and domain name.

getWebFunctionRevision

abstract suspend fun getWebFunctionRevision(input: GetWebFunctionRevisionRequest): GetWebFunctionRevisionResponse

Retrieves details about a web function revision, including its state and configuration.

listTags

abstract suspend fun listTags(input: ListTagsRequest): ListTagsResponse

Returns a list of tags applied to a web function.

listWebFunctionEndpoints

abstract suspend fun listWebFunctionEndpoints(input: ListWebFunctionEndpointsRequest): ListWebFunctionEndpointsResponse

Lists endpoints for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

listWebFunctionRevisions

abstract suspend fun listWebFunctionRevisions(input: ListWebFunctionRevisionsRequest): ListWebFunctionRevisionsResponse

Lists revisions for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

listWebFunctions

abstract suspend fun listWebFunctions(input: ListWebFunctionsRequest = ListWebFunctionsRequest { }): ListWebFunctionsResponse

Lists web functions in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

putResourcePolicy

abstract suspend fun putResourcePolicy(input: PutResourcePolicyRequest): PutResourcePolicyResponse

Adds or updates a resource-based policy on a web function. A resource-based policy grants permissions to other AWS accounts or services to perform actions on the web function.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds tags to a web function. If a tag key already exists, the existing value is overwritten with the new value.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from a web function.

updateWebFunctionEndpoint

abstract suspend fun updateWebFunctionEndpoint(input: UpdateWebFunctionEndpointRequest): UpdateWebFunctionEndpointResponse

Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.

Inherited functions

abstract fun close()

createWebFunction

inline suspend fun LambdaWebClient.createWebFunction(crossinline block: CreateWebFunctionRequest.Builder.() -> Unit): CreateWebFunctionResponse

Creates a web function with an initial revision and endpoint. To create a web function, you provide the function name, revision configuration (code and service settings), and endpoint configuration.

createWebFunctionEndpoint

inline suspend fun LambdaWebClient.createWebFunctionEndpoint(crossinline block: CreateWebFunctionEndpointRequest.Builder.() -> Unit): CreateWebFunctionEndpointResponse

Creates an endpoint for a web function. An endpoint exposes the web function over HTTPS and routes traffic to one or more revisions.

createWebFunctionRevision

inline suspend fun LambdaWebClient.createWebFunctionRevision(crossinline block: CreateWebFunctionRevisionRequest.Builder.() -> Unit): CreateWebFunctionRevisionResponse

Creates an immutable revision for a web function. A revision represents a specific version of the function code and configuration.

deleteResourcePolicy

inline suspend fun LambdaWebClient.deleteResourcePolicy(crossinline block: DeleteResourcePolicyRequest.Builder.() -> Unit): DeleteResourcePolicyResponse

Removes the resource-based policy from a web function.

deleteWebFunction

inline suspend fun LambdaWebClient.deleteWebFunction(crossinline block: DeleteWebFunctionRequest.Builder.() -> Unit): DeleteWebFunctionResponse

Deletes a web function and all of its associated revisions and endpoints.

deleteWebFunctionEndpoint

inline suspend fun LambdaWebClient.deleteWebFunctionEndpoint(crossinline block: DeleteWebFunctionEndpointRequest.Builder.() -> Unit): DeleteWebFunctionEndpointResponse

Deletes a web function endpoint.

deleteWebFunctionRevision

inline suspend fun LambdaWebClient.deleteWebFunctionRevision(crossinline block: DeleteWebFunctionRevisionRequest.Builder.() -> Unit): DeleteWebFunctionRevisionResponse

Deletes a web function revision. You cannot delete a revision that is currently serving traffic on an endpoint.

getResourcePolicy

inline suspend fun LambdaWebClient.getResourcePolicy(crossinline block: GetResourcePolicyRequest.Builder.() -> Unit): GetResourcePolicyResponse

Retrieves the resource-based policy attached to a web function.

getWebAccountSettings

inline suspend fun LambdaWebClient.getWebAccountSettings(crossinline block: GetWebAccountSettingsRequest.Builder.() -> Unit): GetWebAccountSettingsResponse

Retrieves details about your AWS Lambda Web Functions account settings for the current AWS Region, including the quotas that apply to web functions and your current usage.

getWebFunction

inline suspend fun LambdaWebClient.getWebFunction(crossinline block: GetWebFunctionRequest.Builder.() -> Unit): GetWebFunctionResponse

Retrieves details about a web function, including its current state and configuration.

getWebFunctionEndpoint

inline suspend fun LambdaWebClient.getWebFunctionEndpoint(crossinline block: GetWebFunctionEndpointRequest.Builder.() -> Unit): GetWebFunctionEndpointResponse

Retrieves details about a web function endpoint, including its current state, configuration, and domain name.

getWebFunctionRevision

inline suspend fun LambdaWebClient.getWebFunctionRevision(crossinline block: GetWebFunctionRevisionRequest.Builder.() -> Unit): GetWebFunctionRevisionResponse

Retrieves details about a web function revision, including its state and configuration.

listTags

inline suspend fun LambdaWebClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

Returns a list of tags applied to a web function.

listWebFunctionEndpoints

inline suspend fun LambdaWebClient.listWebFunctionEndpoints(crossinline block: ListWebFunctionEndpointsRequest.Builder.() -> Unit): ListWebFunctionEndpointsResponse

Lists endpoints for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

listWebFunctionEndpointsPaginated

fun LambdaWebClient.listWebFunctionEndpointsPaginated(initialRequest: ListWebFunctionEndpointsRequest): Flow<ListWebFunctionEndpointsResponse>

fun LambdaWebClient.listWebFunctionEndpointsPaginated(block: ListWebFunctionEndpointsRequest.Builder.() -> Unit): Flow<ListWebFunctionEndpointsResponse>

Paginate over ListWebFunctionEndpointsResponse results.

listWebFunctionRevisions

inline suspend fun LambdaWebClient.listWebFunctionRevisions(crossinline block: ListWebFunctionRevisionsRequest.Builder.() -> Unit): ListWebFunctionRevisionsResponse

Lists revisions for a web function. We recommend using pagination to ensure that the operation returns quickly and successfully.

listWebFunctionRevisionsPaginated

fun LambdaWebClient.listWebFunctionRevisionsPaginated(initialRequest: ListWebFunctionRevisionsRequest): Flow<ListWebFunctionRevisionsResponse>

fun LambdaWebClient.listWebFunctionRevisionsPaginated(block: ListWebFunctionRevisionsRequest.Builder.() -> Unit): Flow<ListWebFunctionRevisionsResponse>

Paginate over ListWebFunctionRevisionsResponse results.

listWebFunctions

inline suspend fun LambdaWebClient.listWebFunctions(crossinline block: ListWebFunctionsRequest.Builder.() -> Unit): ListWebFunctionsResponse

Lists web functions in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

listWebFunctionsPaginated

fun LambdaWebClient.listWebFunctionsPaginated(initialRequest: ListWebFunctionsRequest = ListWebFunctionsRequest { }): Flow<ListWebFunctionsResponse>

fun LambdaWebClient.listWebFunctionsPaginated(block: ListWebFunctionsRequest.Builder.() -> Unit): Flow<ListWebFunctionsResponse>

Paginate over ListWebFunctionsResponse results.

putResourcePolicy

inline suspend fun LambdaWebClient.putResourcePolicy(crossinline block: PutResourcePolicyRequest.Builder.() -> Unit): PutResourcePolicyResponse

Adds or updates a resource-based policy on a web function. A resource-based policy grants permissions to other AWS accounts or services to perform actions on the web function.

tagResource

inline suspend fun LambdaWebClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to a web function. If a tag key already exists, the existing value is overwritten with the new value.

untagResource

inline suspend fun LambdaWebClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a web function.

updateWebFunctionEndpoint

inline suspend fun LambdaWebClient.updateWebFunctionEndpoint(crossinline block: UpdateWebFunctionEndpointRequest.Builder.() -> Unit): UpdateWebFunctionEndpointResponse

Updates the configuration of a web function endpoint. You can modify the authorization type, auto-deployment mode, revision weights, scaling, and throttling settings.

waitUntilWebFunctionActive

suspend fun LambdaWebClient.waitUntilWebFunctionActive(block: GetWebFunctionRequest.Builder.() -> Unit): Outcome<GetWebFunctionResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionActive(request: GetWebFunctionRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionResponse>

Waits for the web function's state to be Active. This should be used after new function creation.

waitUntilWebFunctionDeleted

suspend fun LambdaWebClient.waitUntilWebFunctionDeleted(block: GetWebFunctionRequest.Builder.() -> Unit): Outcome<GetWebFunctionResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionDeleted(request: GetWebFunctionRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionResponse>

Waits for the web function to be deleted. This should be used after function deletion.

waitUntilWebFunctionEndpointActive

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointActive(block: GetWebFunctionEndpointRequest.Builder.() -> Unit): Outcome<GetWebFunctionEndpointResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointActive(request: GetWebFunctionEndpointRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionEndpointResponse>

Waits for the web function endpoint's state to be Active. This should be used after new endpoint creation.

waitUntilWebFunctionEndpointDeleted

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointDeleted(block: GetWebFunctionEndpointRequest.Builder.() -> Unit): Outcome<GetWebFunctionEndpointResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointDeleted(request: GetWebFunctionEndpointRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionEndpointResponse>

Waits for the web function endpoint to be deleted. This should be used after endpoint deletion.

waitUntilWebFunctionEndpointUpdated

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointUpdated(block: GetWebFunctionEndpointRequest.Builder.() -> Unit): Outcome<GetWebFunctionEndpointResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionEndpointUpdated(request: GetWebFunctionEndpointRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionEndpointResponse>

Waits for the web function endpoint's update status to be Successful. This should be used after endpoint updates.

waitUntilWebFunctionRevisionActive

suspend fun LambdaWebClient.waitUntilWebFunctionRevisionActive(block: GetWebFunctionRevisionRequest.Builder.() -> Unit): Outcome<GetWebFunctionRevisionResponse>

suspend fun LambdaWebClient.waitUntilWebFunctionRevisionActive(request: GetWebFunctionRevisionRequest, retryStrategy: RetryStrategy? = null): Outcome<GetWebFunctionRevisionResponse>

Waits for the web function revision's state to be Active. This should be used after new revision creation.

withConfig

fun LambdaWebClient.withConfig(block: LambdaWebClient.Config.Builder.() -> Unit): LambdaWebClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.