controlcatalog/aws.sdk.kotlin.services.controlcatalog/ControlCatalogClient

ControlCatalogClient

interface ControlCatalogClient : SdkClient

Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog.

Use the following links to get started with the Control Catalog API:

Actions: An alphabetical list of all Control Catalog API operations.
Data types: An alphabetical list of all Control Catalog data types.
Common parameters: Parameters that all operations can use.
Common errors: Client and server errors that all operations can return.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: ControlCatalogClient.Config

ControlCatalogClient's configuration

Functions

getControl

abstract suspend fun getControl(input: GetControlRequest): GetControlResponse

Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

listCommonControls

abstract suspend fun listCommonControls(input: ListCommonControlsRequest = ListCommonControlsRequest { }): ListCommonControlsResponse

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

listControlMappings

abstract suspend fun listControlMappings(input: ListControlMappingsRequest = ListControlMappingsRequest { }): ListControlMappingsResponse

Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

listControls

abstract suspend fun listControls(input: ListControlsRequest = ListControlsRequest { }): ListControlsResponse

Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

listDomains

abstract suspend fun listDomains(input: ListDomainsRequest = ListDomainsRequest { }): ListDomainsResponse

Returns a paginated list of domains from the Control Catalog.

listObjectives

abstract suspend fun listObjectives(input: ListObjectivesRequest = ListObjectivesRequest { }): ListObjectivesResponse

Returns a paginated list of objectives from the Control Catalog.

Inherited functions

expect abstract fun close()

getControl

inline suspend fun ControlCatalogClient.getControl(crossinline block: GetControlRequest.Builder.() -> Unit): GetControlResponse

listCommonControls

inline suspend fun ControlCatalogClient.listCommonControls(crossinline block: ListCommonControlsRequest.Builder.() -> Unit): ListCommonControlsResponse

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

listCommonControlsPaginated

fun ControlCatalogClient.listCommonControlsPaginated(initialRequest: ListCommonControlsRequest = ListCommonControlsRequest { }): Flow<ListCommonControlsResponse>

fun ControlCatalogClient.listCommonControlsPaginated(block: ListCommonControlsRequest.Builder.() -> Unit): Flow<ListCommonControlsResponse>

Paginate over ListCommonControlsResponse results.

listControlMappings

inline suspend fun ControlCatalogClient.listControlMappings(crossinline block: ListControlMappingsRequest.Builder.() -> Unit): ListControlMappingsResponse

Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

listControlMappingsPaginated

fun ControlCatalogClient.listControlMappingsPaginated(initialRequest: ListControlMappingsRequest = ListControlMappingsRequest { }): Flow<ListControlMappingsResponse>

fun ControlCatalogClient.listControlMappingsPaginated(block: ListControlMappingsRequest.Builder.() -> Unit): Flow<ListControlMappingsResponse>

Paginate over ListControlMappingsResponse results.

listControls

inline suspend fun ControlCatalogClient.listControls(crossinline block: ListControlsRequest.Builder.() -> Unit): ListControlsResponse

listControlsPaginated

fun ControlCatalogClient.listControlsPaginated(initialRequest: ListControlsRequest = ListControlsRequest { }): Flow<ListControlsResponse>

fun ControlCatalogClient.listControlsPaginated(block: ListControlsRequest.Builder.() -> Unit): Flow<ListControlsResponse>

Paginate over ListControlsResponse results.

listDomains

inline suspend fun ControlCatalogClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

Returns a paginated list of domains from the Control Catalog.

listDomainsPaginated

fun ControlCatalogClient.listDomainsPaginated(initialRequest: ListDomainsRequest = ListDomainsRequest { }): Flow<ListDomainsResponse>

fun ControlCatalogClient.listDomainsPaginated(block: ListDomainsRequest.Builder.() -> Unit): Flow<ListDomainsResponse>

Paginate over ListDomainsResponse results.

listObjectives

inline suspend fun ControlCatalogClient.listObjectives(crossinline block: ListObjectivesRequest.Builder.() -> Unit): ListObjectivesResponse

Returns a paginated list of objectives from the Control Catalog.

listObjectivesPaginated

fun ControlCatalogClient.listObjectivesPaginated(initialRequest: ListObjectivesRequest = ListObjectivesRequest { }): Flow<ListObjectivesResponse>

fun ControlCatalogClient.listObjectivesPaginated(block: ListObjectivesRequest.Builder.() -> Unit): Flow<ListObjectivesResponse>

Paginate over ListObjectivesResponse results.

withConfig

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

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.