controlcatalog/aws.sdk.kotlin.services.controlcatalog

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

getControl

inline suspend fun ControlCatalogClient.getControl(crossinline block: GetControlRequest.Builder.() -> Unit): 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

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.

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.

listControls

inline suspend fun ControlCatalogClient.listControls(crossinline block: ListControlsRequest.Builder.() -> Unit): 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

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

Returns a paginated list of domains from the Control Catalog.

listObjectives

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

Returns a paginated list of objectives from the Control Catalog.

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.