Package software.amazon.awssdk.services.servicecatalogappregistry

Interface ServiceCatalogAppRegistryClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ServiceCatalogAppRegistryClient
extends AwsClient

Service client for accessing AppRegistry. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateAttributeGroupResponse	associateAttributeGroup(Consumer<AssociateAttributeGroupRequest.Builder> associateAttributeGroupRequest)	Associates an attribute group with an application to augment the application's metadata with the group's attributes.
default AssociateAttributeGroupResponse	associateAttributeGroup(AssociateAttributeGroupRequest associateAttributeGroupRequest)	Associates an attribute group with an application to augment the application's metadata with the group's attributes.
default AssociateResourceResponse	associateResource(Consumer<AssociateResourceRequest.Builder> associateResourceRequest)	Associates a resource with an application.
default AssociateResourceResponse	associateResource(AssociateResourceRequest associateResourceRequest)	Associates a resource with an application.
static ServiceCatalogAppRegistryClientBuilder	builder()	Create a builder that can be used to configure and create a ServiceCatalogAppRegistryClient.
static ServiceCatalogAppRegistryClient	create()	Create a ServiceCatalogAppRegistryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApplicationResponse	createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)	Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
default CreateApplicationResponse	createApplication(CreateApplicationRequest createApplicationRequest)	Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
default CreateAttributeGroupResponse	createAttributeGroup(Consumer<CreateAttributeGroupRequest.Builder> createAttributeGroupRequest)	Creates a new attribute group as a container for user-defined attributes.
default CreateAttributeGroupResponse	createAttributeGroup(CreateAttributeGroupRequest createAttributeGroupRequest)	Creates a new attribute group as a container for user-defined attributes.
default DeleteApplicationResponse	deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)	Deletes an application that is specified either by its application ID, name, or ARN.
default DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)	Deletes an application that is specified either by its application ID, name, or ARN.
default DeleteAttributeGroupResponse	deleteAttributeGroup(Consumer<DeleteAttributeGroupRequest.Builder> deleteAttributeGroupRequest)	Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
default DeleteAttributeGroupResponse	deleteAttributeGroup(DeleteAttributeGroupRequest deleteAttributeGroupRequest)	Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
default DisassociateAttributeGroupResponse	disassociateAttributeGroup(Consumer<DisassociateAttributeGroupRequest.Builder> disassociateAttributeGroupRequest)	Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
default DisassociateAttributeGroupResponse	disassociateAttributeGroup(DisassociateAttributeGroupRequest disassociateAttributeGroupRequest)	Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
default DisassociateResourceResponse	disassociateResource(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest)	Disassociates a resource from application.
default DisassociateResourceResponse	disassociateResource(DisassociateResourceRequest disassociateResourceRequest)	Disassociates a resource from application.
default GetApplicationResponse	getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)	Retrieves metadata information about one of your applications.
default GetApplicationResponse	getApplication(GetApplicationRequest getApplicationRequest)	Retrieves metadata information about one of your applications.
default GetAssociatedResourceResponse	getAssociatedResource(Consumer<GetAssociatedResourceRequest.Builder> getAssociatedResourceRequest)	Gets the resource associated with the application.
default GetAssociatedResourceResponse	getAssociatedResource(GetAssociatedResourceRequest getAssociatedResourceRequest)	Gets the resource associated with the application.
default GetAttributeGroupResponse	getAttributeGroup(Consumer<GetAttributeGroupRequest.Builder> getAttributeGroupRequest)	Retrieves an attribute group by its ARN, ID, or name.
default GetAttributeGroupResponse	getAttributeGroup(GetAttributeGroupRequest getAttributeGroupRequest)	Retrieves an attribute group by its ARN, ID, or name.
default GetConfigurationResponse	getConfiguration(Consumer<GetConfigurationRequest.Builder> getConfigurationRequest)	Retrieves a TagKey configuration from an account.
default GetConfigurationResponse	getConfiguration(GetConfigurationRequest getConfigurationRequest)	Retrieves a TagKey configuration from an account.
default ListApplicationsResponse	listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	Retrieves a list of all of your applications.
default ListApplicationsResponse	listApplications(ListApplicationsRequest listApplicationsRequest)	Retrieves a list of all of your applications.
default ListApplicationsIterable	listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation.
default ListApplicationsIterable	listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)	This is a variant of listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation.
default ListAssociatedAttributeGroupsResponse	listAssociatedAttributeGroups(Consumer<ListAssociatedAttributeGroupsRequest.Builder> listAssociatedAttributeGroupsRequest)	Lists all attribute groups that are associated with specified application.
default ListAssociatedAttributeGroupsResponse	listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)	Lists all attribute groups that are associated with specified application.
default ListAssociatedAttributeGroupsIterable	listAssociatedAttributeGroupsPaginator(Consumer<ListAssociatedAttributeGroupsRequest.Builder> listAssociatedAttributeGroupsRequest)	This is a variant of listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation.
default ListAssociatedAttributeGroupsIterable	listAssociatedAttributeGroupsPaginator(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)	This is a variant of listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation.
default ListAssociatedResourcesResponse	listAssociatedResources(Consumer<ListAssociatedResourcesRequest.Builder> listAssociatedResourcesRequest)	Lists all of the resources that are associated with the specified application.
default ListAssociatedResourcesResponse	listAssociatedResources(ListAssociatedResourcesRequest listAssociatedResourcesRequest)	Lists all of the resources that are associated with the specified application.
default ListAssociatedResourcesIterable	listAssociatedResourcesPaginator(Consumer<ListAssociatedResourcesRequest.Builder> listAssociatedResourcesRequest)	This is a variant of listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation.
default ListAssociatedResourcesIterable	listAssociatedResourcesPaginator(ListAssociatedResourcesRequest listAssociatedResourcesRequest)	This is a variant of listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation.
default ListAttributeGroupsResponse	listAttributeGroups(Consumer<ListAttributeGroupsRequest.Builder> listAttributeGroupsRequest)	Lists all attribute groups which you have access to.
default ListAttributeGroupsResponse	listAttributeGroups(ListAttributeGroupsRequest listAttributeGroupsRequest)	Lists all attribute groups which you have access to.
default ListAttributeGroupsForApplicationResponse	listAttributeGroupsForApplication(Consumer<ListAttributeGroupsForApplicationRequest.Builder> listAttributeGroupsForApplicationRequest)	Lists the details of all attribute groups associated with a specific application.
default ListAttributeGroupsForApplicationResponse	listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)	Lists the details of all attribute groups associated with a specific application.
default ListAttributeGroupsForApplicationIterable	listAttributeGroupsForApplicationPaginator(Consumer<ListAttributeGroupsForApplicationRequest.Builder> listAttributeGroupsForApplicationRequest)	This is a variant of listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation.
default ListAttributeGroupsForApplicationIterable	listAttributeGroupsForApplicationPaginator(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)	This is a variant of listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation.
default ListAttributeGroupsIterable	listAttributeGroupsPaginator(Consumer<ListAttributeGroupsRequest.Builder> listAttributeGroupsRequest)	This is a variant of listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation.
default ListAttributeGroupsIterable	listAttributeGroupsPaginator(ListAttributeGroupsRequest listAttributeGroupsRequest)	This is a variant of listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all of the tags on the resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all of the tags on the resource.
default PutConfigurationResponse	putConfiguration(Consumer<PutConfigurationRequest.Builder> putConfigurationRequest)	Associates a TagKey configuration to an account.
default PutConfigurationResponse	putConfiguration(PutConfigurationRequest putConfigurationRequest)	Associates a TagKey configuration to an account.
default ServiceCatalogAppRegistryServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SyncResourceResponse	syncResource(Consumer<SyncResourceRequest.Builder> syncResourceRequest)	Syncs the resource with current AppRegistry records.
default SyncResourceResponse	syncResource(SyncResourceRequest syncResourceRequest)	Syncs the resource with current AppRegistry records.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Assigns one or more tags (key-value pairs) to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a resource.
default UpdateApplicationResponse	updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)	Updates an existing application with new attributes.
default UpdateApplicationResponse	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Updates an existing application with new attributes.
default UpdateAttributeGroupResponse	updateAttributeGroup(Consumer<UpdateAttributeGroupRequest.Builder> updateAttributeGroupRequest)	Updates an existing attribute group with new details.
default UpdateAttributeGroupResponse	updateAttributeGroup(UpdateAttributeGroupRequest updateAttributeGroupRequest)	Updates an existing attribute group with new details.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateAttributeGroup

default AssociateAttributeGroupResponse associateAttributeGroup(AssociateAttributeGroupRequest associateAttributeGroupRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Parameters:

associateAttributeGroupRequest -

Returns:

Result of the AssociateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

associateAttributeGroup

default AssociateAttributeGroupResponse associateAttributeGroup(Consumer<AssociateAttributeGroupRequest.Builder> associateAttributeGroupRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

This is a convenience which creates an instance of the AssociateAttributeGroupRequest.Builder avoiding the need to create one manually via AssociateAttributeGroupRequest.builder()

Parameters:

associateAttributeGroupRequest - A Consumer that will call methods on AssociateAttributeGroupRequest.Builder to create a request.

Returns:

Result of the AssociateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

associateResource

default AssociateResourceResponse associateResource(AssociateResourceRequest associateResourceRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Minimum permissions

You must have the following permissions to associate a resource using the OPTIONS parameter set to APPLY_APPLICATION_TAG.

• tag:GetResources

• tag:TagResources

You must also have these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.

• resource-groups:AssociateResource

• cloudformation:UpdateStack

• cloudformation:DescribeStacks

In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference.

Parameters:

associateResourceRequest -

Returns:

Result of the AssociateResource operation returned by the service.

See Also:

• AWS API Documentation

associateResource

default AssociateResourceResponse associateResource(Consumer<AssociateResourceRequest.Builder> associateResourceRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Minimum permissions

You must have the following permissions to associate a resource using the OPTIONS parameter set to APPLY_APPLICATION_TAG.

• tag:GetResources

• tag:TagResources

You must also have these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.

• resource-groups:AssociateResource

• cloudformation:UpdateStack

• cloudformation:DescribeStacks

In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference.

This is a convenience which creates an instance of the AssociateResourceRequest.Builder avoiding the need to create one manually via AssociateResourceRequest.builder()

Parameters:

associateResourceRequest - A Consumer that will call methods on AssociateResourceRequest.Builder to create a request.

Returns:

Result of the AssociateResource operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
                                             throws ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
                                             throws ServiceQuotaExceededException,
ConflictException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need to create one manually via CreateApplicationRequest.builder()

Parameters:

createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

createAttributeGroup

default CreateAttributeGroupResponse createAttributeGroup(CreateAttributeGroupRequest createAttributeGroupRequest)
                                                   throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Parameters:

createAttributeGroupRequest -

Returns:

Result of the CreateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

createAttributeGroup

default CreateAttributeGroupResponse createAttributeGroup(Consumer<CreateAttributeGroupRequest.Builder> createAttributeGroupRequest)
                                                   throws ServiceQuotaExceededException,
ConflictException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

This is a convenience which creates an instance of the CreateAttributeGroupRequest.Builder avoiding the need to create one manually via CreateAttributeGroupRequest.builder()

Parameters:

createAttributeGroupRequest - A Consumer that will call methods on CreateAttributeGroupRequest.Builder to create a request.

Returns:

Result of the CreateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need to create one manually via DeleteApplicationRequest.builder()

Parameters:

deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteAttributeGroup

default DeleteAttributeGroupResponse deleteAttributeGroup(DeleteAttributeGroupRequest deleteAttributeGroupRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

deleteAttributeGroupRequest -

Returns:

Result of the DeleteAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteAttributeGroup

default DeleteAttributeGroupResponse deleteAttributeGroup(Consumer<DeleteAttributeGroupRequest.Builder> deleteAttributeGroupRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the DeleteAttributeGroupRequest.Builder avoiding the need to create one manually via DeleteAttributeGroupRequest.builder()

Parameters:

deleteAttributeGroupRequest - A Consumer that will call methods on DeleteAttributeGroupRequest.Builder to create a request.

Returns:

Result of the DeleteAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

disassociateAttributeGroup

default DisassociateAttributeGroupResponse disassociateAttributeGroup(DisassociateAttributeGroupRequest disassociateAttributeGroupRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Parameters:

disassociateAttributeGroupRequest -

Returns:

Result of the DisassociateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

disassociateAttributeGroup

default DisassociateAttributeGroupResponse disassociateAttributeGroup(Consumer<DisassociateAttributeGroupRequest.Builder> disassociateAttributeGroupRequest)
                                                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

This is a convenience which creates an instance of the DisassociateAttributeGroupRequest.Builder avoiding the need to create one manually via DisassociateAttributeGroupRequest.builder()

Parameters:

disassociateAttributeGroupRequest - A Consumer that will call methods on DisassociateAttributeGroupRequest.Builder to create a request.

Returns:

Result of the DisassociateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

disassociateResource

default DisassociateResourceResponse disassociateResource(DisassociateResourceRequest disassociateResourceRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Minimum permissions

You must have the following permissions to remove a resource that's been associated with an application using the APPLY_APPLICATION_TAG option for AssociateResource.

• tag:GetResources

• tag:UntagResources

You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.

• resource-groups:DisassociateResource

• cloudformation:UpdateStack

• cloudformation:DescribeStacks

In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see UntagResources in the Resource Groups Tagging API Reference.

Parameters:

disassociateResourceRequest -

Returns:

Result of the DisassociateResource operation returned by the service.

See Also:

• AWS API Documentation

disassociateResource

default DisassociateResourceResponse disassociateResource(Consumer<DisassociateResourceRequest.Builder> disassociateResourceRequest)
                                                   throws ResourceNotFoundException,
InternalServerException,
ValidationException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Minimum permissions

You must have the following permissions to remove a resource that's been associated with an application using the APPLY_APPLICATION_TAG option for AssociateResource.

• tag:GetResources

• tag:UntagResources

You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.

• resource-groups:DisassociateResource

• cloudformation:UpdateStack

• cloudformation:DescribeStacks

In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see UntagResources in the Resource Groups Tagging API Reference.

This is a convenience which creates an instance of the DisassociateResourceRequest.Builder avoiding the need to create one manually via DisassociateResourceRequest.builder()

Parameters:

disassociateResourceRequest - A Consumer that will call methods on DisassociateResourceRequest.Builder to create a request.

Returns:

Result of the DisassociateResource operation returned by the service.

See Also:

• AWS API Documentation

getApplication

default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest)
                                       throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication operation returned by the service.

See Also:

• AWS API Documentation

getApplication

default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)
                                       throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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.

This is a convenience which creates an instance of the GetApplicationRequest.Builder avoiding the need to create one manually via GetApplicationRequest.builder()

Parameters:

getApplicationRequest - A Consumer that will call methods on GetApplicationRequest.Builder to create a request.

Returns:

Result of the GetApplication operation returned by the service.

See Also:

• AWS API Documentation

getAssociatedResource

default GetAssociatedResourceResponse getAssociatedResource(GetAssociatedResourceRequest getAssociatedResourceRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Gets the resource associated with the application.

Parameters:

getAssociatedResourceRequest -

Returns:

Result of the GetAssociatedResource operation returned by the service.

See Also:

• AWS API Documentation

getAssociatedResource

default GetAssociatedResourceResponse getAssociatedResource(Consumer<GetAssociatedResourceRequest.Builder> getAssociatedResourceRequest)
                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Gets the resource associated with the application.

This is a convenience which creates an instance of the GetAssociatedResourceRequest.Builder avoiding the need to create one manually via GetAssociatedResourceRequest.builder()

Parameters:

getAssociatedResourceRequest - A Consumer that will call methods on GetAssociatedResourceRequest.Builder to create a request.

Returns:

Result of the GetAssociatedResource operation returned by the service.

See Also:

• AWS API Documentation

getAttributeGroup

default GetAttributeGroupResponse getAttributeGroup(GetAttributeGroupRequest getAttributeGroupRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

getAttributeGroupRequest -

Returns:

Result of the GetAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

getAttributeGroup

default GetAttributeGroupResponse getAttributeGroup(Consumer<GetAttributeGroupRequest.Builder> getAttributeGroupRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the GetAttributeGroupRequest.Builder avoiding the need to create one manually via GetAttributeGroupRequest.builder()

Parameters:

getAttributeGroupRequest - A Consumer that will call methods on GetAttributeGroupRequest.Builder to create a request.

Returns:

Result of the GetAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

getConfiguration

default GetConfigurationResponse getConfiguration(GetConfigurationRequest getConfigurationRequest)
                                           throws InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Retrieves a TagKey configuration from an account.

Parameters:

getConfigurationRequest -

Returns:

Result of the GetConfiguration operation returned by the service.

See Also:

• AWS API Documentation

getConfiguration

default GetConfigurationResponse getConfiguration(Consumer<GetConfigurationRequest.Builder> getConfigurationRequest)
                                           throws InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Retrieves a TagKey configuration from an account.

This is a convenience which creates an instance of the GetConfigurationRequest.Builder avoiding the need to create one manually via GetConfigurationRequest.builder()

Parameters:

getConfigurationRequest - A Consumer that will call methods on GetConfigurationRequest.Builder to create a request.

Returns:

Result of the GetConfiguration operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest)
                                           throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                           throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
                                                    throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation.

Parameters:

listApplicationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listApplicationsPaginator

default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                                    throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client
             .listApplicationsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listApplications(software.amazon.awssdk.services.servicecatalogappregistry.model.ListApplicationsRequest) operation.

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedAttributeGroups

default ListAssociatedAttributeGroupsResponse listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)
                                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

listAssociatedAttributeGroupsRequest -

Returns:

Result of the ListAssociatedAttributeGroups operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedAttributeGroups

default ListAssociatedAttributeGroupsResponse listAssociatedAttributeGroups(Consumer<ListAssociatedAttributeGroupsRequest.Builder> listAssociatedAttributeGroupsRequest)
                                                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the ListAssociatedAttributeGroupsRequest.Builder avoiding the need to create one manually via ListAssociatedAttributeGroupsRequest.builder()

Parameters:

listAssociatedAttributeGroupsRequest - A Consumer that will call methods on ListAssociatedAttributeGroupsRequest.Builder to create a request.

Returns:

Result of the ListAssociatedAttributeGroups operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedAttributeGroupsPaginator

default ListAssociatedAttributeGroupsIterable listAssociatedAttributeGroupsPaginator(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)
                                                                              throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client.listAssociatedAttributeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client
             .listAssociatedAttributeGroupsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client.listAssociatedAttributeGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation.

Parameters:

listAssociatedAttributeGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedAttributeGroupsPaginator

default ListAssociatedAttributeGroupsIterable listAssociatedAttributeGroupsPaginator(Consumer<ListAssociatedAttributeGroupsRequest.Builder> listAssociatedAttributeGroupsRequest)
                                                                              throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client.listAssociatedAttributeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client
             .listAssociatedAttributeGroupsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedAttributeGroupsIterable responses = client.listAssociatedAttributeGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedAttributeGroupsRequest) operation.

This is a convenience which creates an instance of the ListAssociatedAttributeGroupsRequest.Builder avoiding the need to create one manually via ListAssociatedAttributeGroupsRequest.builder()

Parameters:

listAssociatedAttributeGroupsRequest - A Consumer that will call methods on ListAssociatedAttributeGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedResources

default ListAssociatedResourcesResponse listAssociatedResources(ListAssociatedResourcesRequest listAssociatedResourcesRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

Parameters:

listAssociatedResourcesRequest -

Returns:

Result of the ListAssociatedResources operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedResources

default ListAssociatedResourcesResponse listAssociatedResources(Consumer<ListAssociatedResourcesRequest.Builder> listAssociatedResourcesRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.

This is a convenience which creates an instance of the ListAssociatedResourcesRequest.Builder avoiding the need to create one manually via ListAssociatedResourcesRequest.builder()

Parameters:

listAssociatedResourcesRequest - A Consumer that will call methods on ListAssociatedResourcesRequest.Builder to create a request.

Returns:

Result of the ListAssociatedResources operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedResourcesPaginator

default ListAssociatedResourcesIterable listAssociatedResourcesPaginator(ListAssociatedResourcesRequest listAssociatedResourcesRequest)
                                                                  throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client.listAssociatedResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client
             .listAssociatedResourcesPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client.listAssociatedResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation.

Parameters:

listAssociatedResourcesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedResourcesPaginator

default ListAssociatedResourcesIterable listAssociatedResourcesPaginator(Consumer<ListAssociatedResourcesRequest.Builder> listAssociatedResourcesRequest)
                                                                  throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client.listAssociatedResourcesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client
             .listAssociatedResourcesPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAssociatedResourcesIterable responses = client.listAssociatedResourcesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedResources(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAssociatedResourcesRequest) operation.

This is a convenience which creates an instance of the ListAssociatedResourcesRequest.Builder avoiding the need to create one manually via ListAssociatedResourcesRequest.builder()

Parameters:

listAssociatedResourcesRequest - A Consumer that will call methods on ListAssociatedResourcesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAttributeGroups

default ListAttributeGroupsResponse listAttributeGroups(ListAttributeGroupsRequest listAttributeGroupsRequest)
                                                 throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

listAttributeGroupsRequest -

Returns:

Result of the ListAttributeGroups operation returned by the service.

See Also:

• AWS API Documentation

listAttributeGroups

default ListAttributeGroupsResponse listAttributeGroups(Consumer<ListAttributeGroupsRequest.Builder> listAttributeGroupsRequest)
                                                 throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the ListAttributeGroupsRequest.Builder avoiding the need to create one manually via ListAttributeGroupsRequest.builder()

Parameters:

listAttributeGroupsRequest - A Consumer that will call methods on ListAttributeGroupsRequest.Builder to create a request.

Returns:

Result of the ListAttributeGroups operation returned by the service.

See Also:

• AWS API Documentation

listAttributeGroupsPaginator

default ListAttributeGroupsIterable listAttributeGroupsPaginator(ListAttributeGroupsRequest listAttributeGroupsRequest)
                                                          throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client.listAttributeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client
             .listAttributeGroupsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client.listAttributeGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation.

Parameters:

listAttributeGroupsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAttributeGroupsPaginator

default ListAttributeGroupsIterable listAttributeGroupsPaginator(Consumer<ListAttributeGroupsRequest.Builder> listAttributeGroupsRequest)
                                                          throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client.listAttributeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client
             .listAttributeGroupsPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsIterable responses = client.listAttributeGroupsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttributeGroups(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsRequest) operation.

This is a convenience which creates an instance of the ListAttributeGroupsRequest.Builder avoiding the need to create one manually via ListAttributeGroupsRequest.builder()

Parameters:

listAttributeGroupsRequest - A Consumer that will call methods on ListAttributeGroupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAttributeGroupsForApplication

default ListAttributeGroupsForApplicationResponse listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)
                                                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Parameters:

listAttributeGroupsForApplicationRequest -

Returns:

Result of the ListAttributeGroupsForApplication operation returned by the service.

See Also:

• AWS API Documentation

listAttributeGroupsForApplication

default ListAttributeGroupsForApplicationResponse listAttributeGroupsForApplication(Consumer<ListAttributeGroupsForApplicationRequest.Builder> listAttributeGroupsForApplicationRequest)
                                                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

This is a convenience which creates an instance of the ListAttributeGroupsForApplicationRequest.Builder avoiding the need to create one manually via ListAttributeGroupsForApplicationRequest.builder()

Parameters:

listAttributeGroupsForApplicationRequest - A Consumer that will call methods on ListAttributeGroupsForApplicationRequest.Builder to create a request.

Returns:

Result of the ListAttributeGroupsForApplication operation returned by the service.

See Also:

• AWS API Documentation

listAttributeGroupsForApplicationPaginator

default ListAttributeGroupsForApplicationIterable listAttributeGroupsForApplicationPaginator(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)
                                                                                      throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client.listAttributeGroupsForApplicationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client
             .listAttributeGroupsForApplicationPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client.listAttributeGroupsForApplicationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation.

Parameters:

listAttributeGroupsForApplicationRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAttributeGroupsForApplicationPaginator

default ListAttributeGroupsForApplicationIterable listAttributeGroupsForApplicationPaginator(Consumer<ListAttributeGroupsForApplicationRequest.Builder> listAttributeGroupsForApplicationRequest)
                                                                                      throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

This is a variant of listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client.listAttributeGroupsForApplicationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client
             .listAttributeGroupsForApplicationPaginator(request);
     for (software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.servicecatalogappregistry.paginators.ListAttributeGroupsForApplicationIterable responses = client.listAttributeGroupsForApplicationPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAttributeGroupsForApplication(software.amazon.awssdk.services.servicecatalogappregistry.model.ListAttributeGroupsForApplicationRequest) operation.

This is a convenience which creates an instance of the ListAttributeGroupsForApplicationRequest.Builder avoiding the need to create one manually via ListAttributeGroupsForApplicationRequest.builder()

Parameters:

listAttributeGroupsForApplicationRequest - A Consumer that will call methods on ListAttributeGroupsForApplicationRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Lists all of the tags on the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Lists all of the tags on the resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putConfiguration

default PutConfigurationResponse putConfiguration(PutConfigurationRequest putConfigurationRequest)
                                           throws ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Associates a TagKey configuration to an account.

Parameters:

putConfigurationRequest -

Returns:

Result of the PutConfiguration operation returned by the service.

See Also:

• AWS API Documentation

putConfiguration

default PutConfigurationResponse putConfiguration(Consumer<PutConfigurationRequest.Builder> putConfigurationRequest)
                                           throws ConflictException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Associates a TagKey configuration to an account.

This is a convenience which creates an instance of the PutConfigurationRequest.Builder avoiding the need to create one manually via PutConfigurationRequest.builder()

Parameters:

putConfigurationRequest - A Consumer that will call methods on PutConfigurationRequest.Builder to create a request.

Returns:

Result of the PutConfiguration operation returned by the service.

See Also:

• AWS API Documentation

syncResource

default SyncResourceResponse syncResource(SyncResourceRequest syncResourceRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ConflictException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Syncs the resource with current AppRegistry records.

Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.

Parameters:

syncResourceRequest -

Returns:

Result of the SyncResource operation returned by the service.

See Also:

• AWS API Documentation

syncResource

default SyncResourceResponse syncResource(Consumer<SyncResourceRequest.Builder> syncResourceRequest)
                                   throws ResourceNotFoundException,
InternalServerException,
ConflictException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Syncs the resource with current AppRegistry records.

Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.

This is a convenience which creates an instance of the SyncResourceRequest.Builder avoiding the need to create one manually via SyncResourceRequest.builder()

Parameters:

syncResourceRequest - A Consumer that will call methods on SyncResourceRequest.Builder to create a request.

Returns:

Result of the SyncResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

This operation returns an empty response if the call was successful.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

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

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

This operation returns an empty response if the call was successful.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Removes tags from a resource.

This operation returns an empty response if the call was successful.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Removes tags from a resource.

This operation returns an empty response if the call was successful.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
                                             throws ResourceNotFoundException,
ConflictException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Updates an existing application with new attributes.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
                                             throws ResourceNotFoundException,
ConflictException,
ValidationException,
InternalServerException,
ThrottlingException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Updates an existing application with new attributes.

This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need to create one manually via UpdateApplicationRequest.builder()

Parameters:

updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateAttributeGroup

default UpdateAttributeGroupResponse updateAttributeGroup(UpdateAttributeGroupRequest updateAttributeGroupRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Updates an existing attribute group with new details.

Parameters:

updateAttributeGroupRequest -

Returns:

Result of the UpdateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

updateAttributeGroup

default UpdateAttributeGroupResponse updateAttributeGroup(Consumer<UpdateAttributeGroupRequest.Builder> updateAttributeGroupRequest)
                                                   throws ResourceNotFoundException,
ValidationException,
ConflictException,
InternalServerException,
AwsServiceException,
SdkClientException,
ServiceCatalogAppRegistryException

Updates an existing attribute group with new details.

This is a convenience which creates an instance of the UpdateAttributeGroupRequest.Builder avoiding the need to create one manually via UpdateAttributeGroupRequest.builder()

Parameters:

updateAttributeGroupRequest - A Consumer that will call methods on UpdateAttributeGroupRequest.Builder to create a request.

Returns:

Result of the UpdateAttributeGroup operation returned by the service.

See Also:

• AWS API Documentation

create

static ServiceCatalogAppRegistryClient create()

Create a ServiceCatalogAppRegistryClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ServiceCatalogAppRegistryClientBuilder builder()

Create a builder that can be used to configure and create a ServiceCatalogAppRegistryClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ServiceCatalogAppRegistryServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration