servicecatalogappregistry/aws.sdk.kotlin.services.servicecatalogappregistry

Package-level declarations

Types

interface ServiceCatalogAppRegistryClient : SdkClient

Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

associateAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.associateAttributeGroup(crossinline block: AssociateAttributeGroupRequest.Builder.() -> Unit): AssociateAttributeGroupResponse

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

associateResource

inline suspend fun ServiceCatalogAppRegistryClient.associateResource(crossinline block: AssociateResourceRequest.Builder.() -> Unit): AssociateResourceResponse

Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.

createApplication

inline suspend fun ServiceCatalogAppRegistryClient.createApplication(crossinline block: CreateApplicationRequest.Builder.() -> Unit): CreateApplicationResponse

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

createAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.createAttributeGroup(crossinline block: CreateAttributeGroupRequest.Builder.() -> Unit): CreateAttributeGroupResponse

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

deleteApplication

inline suspend fun ServiceCatalogAppRegistryClient.deleteApplication(crossinline block: DeleteApplicationRequest.Builder.() -> Unit): DeleteApplicationResponse

Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

deleteAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.deleteAttributeGroup(crossinline block: DeleteAttributeGroupRequest.Builder.() -> Unit): DeleteAttributeGroupResponse

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

disassociateAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.disassociateAttributeGroup(crossinline block: DisassociateAttributeGroupRequest.Builder.() -> Unit): DisassociateAttributeGroupResponse

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts AssociateAttributeGroup.

disassociateResource

inline suspend fun ServiceCatalogAppRegistryClient.disassociateResource(crossinline block: DisassociateResourceRequest.Builder.() -> Unit): DisassociateResourceResponse

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

getApplication

inline suspend fun ServiceCatalogAppRegistryClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

getAssociatedResource

inline suspend fun ServiceCatalogAppRegistryClient.getAssociatedResource(crossinline block: GetAssociatedResourceRequest.Builder.() -> Unit): GetAssociatedResourceResponse

Gets the resource associated with the application.

getAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.getAttributeGroup(crossinline block: GetAttributeGroupRequest.Builder.() -> Unit): GetAttributeGroupResponse

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

getConfiguration

inline suspend fun ServiceCatalogAppRegistryClient.getConfiguration(crossinline block: GetConfigurationRequest.Builder.() -> Unit): GetConfigurationResponse

Retrieves a TagKey configuration from an account.

listApplications

inline suspend fun ServiceCatalogAppRegistryClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

Retrieves a list of all of your applications. Results are paginated.

listAssociatedAttributeGroups

inline suspend fun ServiceCatalogAppRegistryClient.listAssociatedAttributeGroups(crossinline block: ListAssociatedAttributeGroupsRequest.Builder.() -> Unit): ListAssociatedAttributeGroupsResponse

Lists all attribute groups that are associated with specified application. Results are paginated.

listAssociatedResources

inline suspend fun ServiceCatalogAppRegistryClient.listAssociatedResources(crossinline block: ListAssociatedResourcesRequest.Builder.() -> Unit): ListAssociatedResourcesResponse

Lists all of the resources that are associated with the specified application. Results are paginated.

listAttributeGroups

inline suspend fun ServiceCatalogAppRegistryClient.listAttributeGroups(crossinline block: ListAttributeGroupsRequest.Builder.() -> Unit): ListAttributeGroupsResponse

Lists all attribute groups which you have access to. Results are paginated.

listAttributeGroupsForApplication

inline suspend fun ServiceCatalogAppRegistryClient.listAttributeGroupsForApplication(crossinline block: ListAttributeGroupsForApplicationRequest.Builder.() -> Unit): ListAttributeGroupsForApplicationResponse

Lists the details of all attribute groups associated with a specific application. The results display in pages.

listTagsForResource

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

Lists all of the tags on the resource.

putConfiguration

inline suspend fun ServiceCatalogAppRegistryClient.putConfiguration(crossinline block: PutConfigurationRequest.Builder.() -> Unit): PutConfigurationResponse

Associates a TagKey configuration to an account.

syncResource

inline suspend fun ServiceCatalogAppRegistryClient.syncResource(crossinline block: SyncResourceRequest.Builder.() -> Unit): SyncResourceResponse

Syncs the resource with current AppRegistry records.

tagResource

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

Assigns one or more tags (key-value pairs) to the specified resource.

untagResource

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

Removes tags from a resource.

updateApplication

inline suspend fun ServiceCatalogAppRegistryClient.updateApplication(crossinline block: UpdateApplicationRequest.Builder.() -> Unit): UpdateApplicationResponse

Updates an existing application with new attributes.

updateAttributeGroup

inline suspend fun ServiceCatalogAppRegistryClient.updateAttributeGroup(crossinline block: UpdateAttributeGroupRequest.Builder.() -> Unit): UpdateAttributeGroupResponse

Updates an existing attribute group with new details.

withConfig

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

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.