resourcegroupstaggingapi/aws.sdk.kotlin.services.resourcegroupstaggingapi

Package-level declarations

Types

ResourceGroupsTaggingClient

interface ResourceGroupsTaggingClient : SdkClient

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Functions

describeReportCreation

inline suspend fun ResourceGroupsTaggingClient.describeReportCreation(crossinline block: DescribeReportCreationRequest.Builder.() -> Unit): DescribeReportCreationResponse

Describes the status of the StartReportCreation operation.

getComplianceSummary

inline suspend fun ResourceGroupsTaggingClient.getComplianceSummary(crossinline block: GetComplianceSummaryRequest.Builder.() -> Unit): GetComplianceSummaryResponse

Returns a table that shows counts of resources that are noncompliant with their tag policies.

inline suspend fun ResourceGroupsTaggingClient.getResources(crossinline block: GetResourcesRequest.Builder.() -> Unit): GetResourcesResponse

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

inline suspend fun ResourceGroupsTaggingClient.getTagKeys(crossinline block: GetTagKeysRequest.Builder.() -> Unit): GetTagKeysResponse

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.

inline suspend fun ResourceGroupsTaggingClient.getTagValues(crossinline block: GetTagValuesRequest.Builder.() -> Unit): GetTagValuesResponse

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

startReportCreation

inline suspend fun ResourceGroupsTaggingClient.startReportCreation(crossinline block: StartReportCreationRequest.Builder.() -> Unit): StartReportCreationResponse

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

inline suspend fun ResourceGroupsTaggingClient.tagResources(crossinline block: TagResourcesRequest.Builder.() -> Unit): TagResourcesResponse

Applies one or more tags to the specified resources. Note the following:

inline suspend fun ResourceGroupsTaggingClient.untagResources(crossinline block: UntagResourcesRequest.Builder.() -> Unit): UntagResourcesResponse

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

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

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.