supportauthz/aws.sdk.kotlin.services.supportauthz/SupportAuthZClient

SupportAuthZClient

interface SupportAuthZClient : SdkClient

AWS Support Authorization

AWS SupportAuthZ enables you to control and authorize the actions that AWS support operators can perform on your resources. You create cryptographically signed support permits specifying which actions operators can perform, on which resources, and under what time-window conditions. Permits are signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: SupportAuthZClient.Config

SupportAuthZClient's configuration

Functions

createSupportPermit

abstract suspend fun createSupportPermit(input: CreateSupportPermitRequest): CreateSupportPermitResponse

Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.

deleteSupportPermit

abstract suspend fun deleteSupportPermit(input: DeleteSupportPermitRequest): DeleteSupportPermitResponse

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

getAction

abstract suspend fun getAction(input: GetActionRequest): GetActionResponse

Retrieves the description of a specific support action.

getSupportPermit

abstract suspend fun getSupportPermit(input: GetSupportPermitRequest): GetSupportPermitResponse

Retrieves the details of a support permit by its ARN or name.

listActions

abstract suspend fun listActions(input: ListActionsRequest): ListActionsResponse

Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.

listSupportPermitRequests

abstract suspend fun listSupportPermitRequests(input: ListSupportPermitRequestsRequest = ListSupportPermitRequestsRequest { }): ListSupportPermitRequestsResponse

Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.

listSupportPermits

abstract suspend fun listSupportPermits(input: ListSupportPermitsRequest = ListSupportPermitsRequest { }): ListSupportPermitsResponse

Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags associated with a support permit resource.

rejectSupportPermitRequest

abstract suspend fun rejectSupportPermitRequest(input: RejectSupportPermitRequestRequest): RejectSupportPermitRequestResponse

Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or overwrites one or more tags for a support permit resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes one or more tags from a support permit resource.

Inherited functions

expect abstract fun close()

createSupportPermit

inline suspend fun SupportAuthZClient.createSupportPermit(crossinline block: CreateSupportPermitRequest.Builder.() -> Unit): CreateSupportPermitResponse

deleteSupportPermit

inline suspend fun SupportAuthZClient.deleteSupportPermit(crossinline block: DeleteSupportPermitRequest.Builder.() -> Unit): DeleteSupportPermitResponse

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

getAction

inline suspend fun SupportAuthZClient.getAction(crossinline block: GetActionRequest.Builder.() -> Unit): GetActionResponse

Retrieves the description of a specific support action.

getSupportPermit

inline suspend fun SupportAuthZClient.getSupportPermit(crossinline block: GetSupportPermitRequest.Builder.() -> Unit): GetSupportPermitResponse

Retrieves the details of a support permit by its ARN or name.

listActions

inline suspend fun SupportAuthZClient.listActions(crossinline block: ListActionsRequest.Builder.() -> Unit): ListActionsResponse

Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.

listActionsPaginated

fun SupportAuthZClient.listActionsPaginated(initialRequest: ListActionsRequest): Flow<ListActionsResponse>

fun SupportAuthZClient.listActionsPaginated(block: ListActionsRequest.Builder.() -> Unit): Flow<ListActionsResponse>

Paginate over ListActionsResponse results.

listSupportPermitRequests

inline suspend fun SupportAuthZClient.listSupportPermitRequests(crossinline block: ListSupportPermitRequestsRequest.Builder.() -> Unit): ListSupportPermitRequestsResponse

Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.

listSupportPermitRequestsPaginated

fun SupportAuthZClient.listSupportPermitRequestsPaginated(initialRequest: ListSupportPermitRequestsRequest = ListSupportPermitRequestsRequest { }): Flow<ListSupportPermitRequestsResponse>

fun SupportAuthZClient.listSupportPermitRequestsPaginated(block: ListSupportPermitRequestsRequest.Builder.() -> Unit): Flow<ListSupportPermitRequestsResponse>

Paginate over ListSupportPermitRequestsResponse results.

listSupportPermits

inline suspend fun SupportAuthZClient.listSupportPermits(crossinline block: ListSupportPermitsRequest.Builder.() -> Unit): ListSupportPermitsResponse

Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

listSupportPermitsPaginated

fun SupportAuthZClient.listSupportPermitsPaginated(initialRequest: ListSupportPermitsRequest = ListSupportPermitsRequest { }): Flow<ListSupportPermitsResponse>

fun SupportAuthZClient.listSupportPermitsPaginated(block: ListSupportPermitsRequest.Builder.() -> Unit): Flow<ListSupportPermitsResponse>

Paginate over ListSupportPermitsResponse results.

listTagsForResource

inline suspend fun SupportAuthZClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags associated with a support permit resource.

rejectSupportPermitRequest

inline suspend fun SupportAuthZClient.rejectSupportPermitRequest(crossinline block: RejectSupportPermitRequestRequest.Builder.() -> Unit): RejectSupportPermitRequestResponse

Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

tagResource

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

Adds or overwrites one or more tags for a support permit resource.

untagResource

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

Removes one or more tags from a support permit resource.

withConfig

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

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.