fis/aws.sdk.kotlin.services.fis/FisClient

FisClient

Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your Amazon Web Services workloads. For more information, see the Fault Injection Simulator User Guide.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: FisClient.Config

FisClient's configuration

Functions

createExperimentTemplate

abstract suspend fun createExperimentTemplate(input: CreateExperimentTemplateRequest): CreateExperimentTemplateResponse

Creates an experiment template.

createTargetAccountConfiguration

abstract suspend fun createTargetAccountConfiguration(input: CreateTargetAccountConfigurationRequest): CreateTargetAccountConfigurationResponse

Creates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Simulator User Guide.

deleteExperimentTemplate

abstract suspend fun deleteExperimentTemplate(input: DeleteExperimentTemplateRequest): DeleteExperimentTemplateResponse

Deletes the specified experiment template.

deleteTargetAccountConfiguration

abstract suspend fun deleteTargetAccountConfiguration(input: DeleteTargetAccountConfigurationRequest): DeleteTargetAccountConfigurationResponse

Deletes the specified target account configuration of the experiment template.

getAction

abstract suspend fun getAction(input: GetActionRequest): GetActionResponse

Gets information about the specified FIS action.

getExperiment

abstract suspend fun getExperiment(input: GetExperimentRequest): GetExperimentResponse

Gets information about the specified experiment.

getExperimentTargetAccountConfiguration

abstract suspend fun getExperimentTargetAccountConfiguration(input: GetExperimentTargetAccountConfigurationRequest): GetExperimentTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment.

getExperimentTemplate

abstract suspend fun getExperimentTemplate(input: GetExperimentTemplateRequest): GetExperimentTemplateResponse

Gets information about the specified experiment template.

getTargetAccountConfiguration

abstract suspend fun getTargetAccountConfiguration(input: GetTargetAccountConfigurationRequest): GetTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment template.

getTargetResourceType

abstract suspend fun getTargetResourceType(input: GetTargetResourceTypeRequest): GetTargetResourceTypeResponse

Gets information about the specified resource type.

listActions

abstract suspend fun listActions(input: ListActionsRequest = ListActionsRequest { }): ListActionsResponse

Lists the available FIS actions.

listExperimentResolvedTargets

abstract suspend fun listExperimentResolvedTargets(input: ListExperimentResolvedTargetsRequest): ListExperimentResolvedTargetsResponse

Lists the resolved targets information of the specified experiment.

listExperiments

abstract suspend fun listExperiments(input: ListExperimentsRequest = ListExperimentsRequest { }): ListExperimentsResponse

Lists your experiments.

listExperimentTargetAccountConfigurations

abstract suspend fun listExperimentTargetAccountConfigurations(input: ListExperimentTargetAccountConfigurationsRequest): ListExperimentTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment.

listExperimentTemplates

abstract suspend fun listExperimentTemplates(input: ListExperimentTemplatesRequest = ListExperimentTemplatesRequest { }): ListExperimentTemplatesResponse

Lists your experiment templates.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for the specified resource.

listTargetAccountConfigurations

abstract suspend fun listTargetAccountConfigurations(input: ListTargetAccountConfigurationsRequest): ListTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment template.

listTargetResourceTypes

abstract suspend fun listTargetResourceTypes(input: ListTargetResourceTypesRequest = ListTargetResourceTypesRequest { }): ListTargetResourceTypesResponse

Lists the target resource types.

startExperiment

abstract suspend fun startExperiment(input: StartExperimentRequest): StartExperimentResponse

Starts running an experiment from the specified experiment template.

stopExperiment

abstract suspend fun stopExperiment(input: StopExperimentRequest): StopExperimentResponse

Stops the specified experiment.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Applies the specified tags to the specified resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes the specified tags from the specified resource.

updateExperimentTemplate

abstract suspend fun updateExperimentTemplate(input: UpdateExperimentTemplateRequest): UpdateExperimentTemplateResponse

Updates the specified experiment template.

updateTargetAccountConfiguration

abstract suspend fun updateTargetAccountConfiguration(input: UpdateTargetAccountConfigurationRequest): UpdateTargetAccountConfigurationResponse

Updates the target account configuration for the specified experiment template.

Inherited functions

expect abstract fun close()

createExperimentTemplate

inline suspend fun FisClient.createExperimentTemplate(crossinline block: CreateExperimentTemplateRequest.Builder.() -> Unit): CreateExperimentTemplateResponse

Creates an experiment template.

createTargetAccountConfiguration

inline suspend fun FisClient.createTargetAccountConfiguration(crossinline block: CreateTargetAccountConfigurationRequest.Builder.() -> Unit): CreateTargetAccountConfigurationResponse

deleteExperimentTemplate

inline suspend fun FisClient.deleteExperimentTemplate(crossinline block: DeleteExperimentTemplateRequest.Builder.() -> Unit): DeleteExperimentTemplateResponse

Deletes the specified experiment template.

deleteTargetAccountConfiguration

inline suspend fun FisClient.deleteTargetAccountConfiguration(crossinline block: DeleteTargetAccountConfigurationRequest.Builder.() -> Unit): DeleteTargetAccountConfigurationResponse

Deletes the specified target account configuration of the experiment template.

getAction

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

Gets information about the specified FIS action.

getExperiment

inline suspend fun FisClient.getExperiment(crossinline block: GetExperimentRequest.Builder.() -> Unit): GetExperimentResponse

Gets information about the specified experiment.

getExperimentTargetAccountConfiguration

inline suspend fun FisClient.getExperimentTargetAccountConfiguration(crossinline block: GetExperimentTargetAccountConfigurationRequest.Builder.() -> Unit): GetExperimentTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment.

getExperimentTemplate

inline suspend fun FisClient.getExperimentTemplate(crossinline block: GetExperimentTemplateRequest.Builder.() -> Unit): GetExperimentTemplateResponse

Gets information about the specified experiment template.

getTargetAccountConfiguration

inline suspend fun FisClient.getTargetAccountConfiguration(crossinline block: GetTargetAccountConfigurationRequest.Builder.() -> Unit): GetTargetAccountConfigurationResponse

Gets information about the specified target account configuration of the experiment template.

getTargetResourceType

inline suspend fun FisClient.getTargetResourceType(crossinline block: GetTargetResourceTypeRequest.Builder.() -> Unit): GetTargetResourceTypeResponse

Gets information about the specified resource type.

listActions

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

Lists the available FIS actions.

listActionsPaginated

fun FisClient.listActionsPaginated(initialRequest: ListActionsRequest = ListActionsRequest { }): Flow<ListActionsResponse>

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

Paginate over ListActionsResponse results.

listExperimentResolvedTargets

inline suspend fun FisClient.listExperimentResolvedTargets(crossinline block: ListExperimentResolvedTargetsRequest.Builder.() -> Unit): ListExperimentResolvedTargetsResponse

Lists the resolved targets information of the specified experiment.

listExperimentResolvedTargetsPaginated

fun FisClient.listExperimentResolvedTargetsPaginated(initialRequest: ListExperimentResolvedTargetsRequest): Flow<ListExperimentResolvedTargetsResponse>

fun FisClient.listExperimentResolvedTargetsPaginated(block: ListExperimentResolvedTargetsRequest.Builder.() -> Unit): Flow<ListExperimentResolvedTargetsResponse>

Paginate over ListExperimentResolvedTargetsResponse results.

listExperiments

inline suspend fun FisClient.listExperiments(crossinline block: ListExperimentsRequest.Builder.() -> Unit): ListExperimentsResponse

Lists your experiments.

listExperimentsPaginated

fun FisClient.listExperimentsPaginated(initialRequest: ListExperimentsRequest = ListExperimentsRequest { }): Flow<ListExperimentsResponse>

fun FisClient.listExperimentsPaginated(block: ListExperimentsRequest.Builder.() -> Unit): Flow<ListExperimentsResponse>

Paginate over ListExperimentsResponse results.

listExperimentTargetAccountConfigurations

inline suspend fun FisClient.listExperimentTargetAccountConfigurations(crossinline block: ListExperimentTargetAccountConfigurationsRequest.Builder.() -> Unit): ListExperimentTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment.

listExperimentTemplates

inline suspend fun FisClient.listExperimentTemplates(crossinline block: ListExperimentTemplatesRequest.Builder.() -> Unit): ListExperimentTemplatesResponse

Lists your experiment templates.

listExperimentTemplatesPaginated

fun FisClient.listExperimentTemplatesPaginated(initialRequest: ListExperimentTemplatesRequest = ListExperimentTemplatesRequest { }): Flow<ListExperimentTemplatesResponse>

fun FisClient.listExperimentTemplatesPaginated(block: ListExperimentTemplatesRequest.Builder.() -> Unit): Flow<ListExperimentTemplatesResponse>

Paginate over ListExperimentTemplatesResponse results.

listTagsForResource

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

Lists the tags for the specified resource.

listTargetAccountConfigurations

inline suspend fun FisClient.listTargetAccountConfigurations(crossinline block: ListTargetAccountConfigurationsRequest.Builder.() -> Unit): ListTargetAccountConfigurationsResponse

Lists the target account configurations of the specified experiment template.

listTargetAccountConfigurationsPaginated

fun FisClient.listTargetAccountConfigurationsPaginated(initialRequest: ListTargetAccountConfigurationsRequest): Flow<ListTargetAccountConfigurationsResponse>

fun FisClient.listTargetAccountConfigurationsPaginated(block: ListTargetAccountConfigurationsRequest.Builder.() -> Unit): Flow<ListTargetAccountConfigurationsResponse>

Paginate over ListTargetAccountConfigurationsResponse results.

listTargetResourceTypes

inline suspend fun FisClient.listTargetResourceTypes(crossinline block: ListTargetResourceTypesRequest.Builder.() -> Unit): ListTargetResourceTypesResponse

Lists the target resource types.

listTargetResourceTypesPaginated

fun FisClient.listTargetResourceTypesPaginated(initialRequest: ListTargetResourceTypesRequest = ListTargetResourceTypesRequest { }): Flow<ListTargetResourceTypesResponse>

fun FisClient.listTargetResourceTypesPaginated(block: ListTargetResourceTypesRequest.Builder.() -> Unit): Flow<ListTargetResourceTypesResponse>

Paginate over ListTargetResourceTypesResponse results.

startExperiment

inline suspend fun FisClient.startExperiment(crossinline block: StartExperimentRequest.Builder.() -> Unit): StartExperimentResponse

Starts running an experiment from the specified experiment template.

stopExperiment

inline suspend fun FisClient.stopExperiment(crossinline block: StopExperimentRequest.Builder.() -> Unit): StopExperimentResponse

Stops the specified experiment.

tagResource

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

Applies the specified tags to the specified resource.

untagResource

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

Removes the specified tags from the specified resource.

updateExperimentTemplate

inline suspend fun FisClient.updateExperimentTemplate(crossinline block: UpdateExperimentTemplateRequest.Builder.() -> Unit): UpdateExperimentTemplateResponse

Updates the specified experiment template.

updateTargetAccountConfiguration

inline suspend fun FisClient.updateTargetAccountConfiguration(crossinline block: UpdateTargetAccountConfigurationRequest.Builder.() -> Unit): UpdateTargetAccountConfigurationResponse

Updates the target account configuration for the specified experiment template.

withConfig

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

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.