AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Application

Represents a Amazon Web Services Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.

Class ApplicationSummary

Summary of a Amazon Web Services Service Catalog AppRegistry application.

Class ApplicationTagResult

The result of the application tag that's applied to a resource.

Class AppRegistryConfiguration

Includes all of the AppRegistry settings.

Class AppRegistryPaginatorFactory

Paginators for the AppRegistry service

Class AssociateAttributeGroupRequest

Container for the parameters to the AssociateAttributeGroup operation. 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.

Class AssociateAttributeGroupResponse

This is the response object from the AssociateAttributeGroup operation.

Class AssociateResourceRequest

Container for the parameters to the AssociateResource operation. 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.

Class AssociateResourceResponse

This is the response object from the AssociateResource operation.

Class AttributeGroup

Represents a Amazon Web Services Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.

Class AttributeGroupDetails

The details related to a specific AttributeGroup.

Class AttributeGroupSummary

Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.

Class ConflictException

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

Class CreateApplicationResponse

This is the response object from the CreateApplication operation.

Class CreateAttributeGroupRequest

Container for the parameters to the CreateAttributeGroup operation. 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.

Class CreateAttributeGroupResponse

This is the response object from the CreateAttributeGroup operation.

Class DeleteApplicationRequest

Container for the parameters to the DeleteApplication operation. 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.

Class DeleteApplicationResponse

This is the response object from the DeleteApplication operation.

Class DeleteAttributeGroupRequest

Container for the parameters to the DeleteAttributeGroup operation. Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

Class DeleteAttributeGroupResponse

This is the response object from the DeleteAttributeGroup operation.

Class DisassociateAttributeGroupRequest

Container for the parameters to the DisassociateAttributeGroup operation. 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.

Class DisassociateAttributeGroupResponse

This is the response object from the DisassociateAttributeGroup operation.

Class DisassociateResourceRequest

Container for the parameters to the DisassociateResource operation. 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.

Class DisassociateResourceResponse

This is the response object from the DisassociateResource operation.

Class GetApplicationRequest

Container for the parameters to the GetApplication operation. 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.

Class GetApplicationResponse

This is the response object from the GetApplication operation.

Class GetAssociatedResourceRequest

Container for the parameters to the GetAssociatedResource operation. Gets the resource associated with the application.

Class GetAssociatedResourceResponse

This is the response object from the GetAssociatedResource operation.

Class GetAttributeGroupRequest

Container for the parameters to the GetAttributeGroup operation. Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

Class GetAttributeGroupResponse

This is the response object from the GetAttributeGroup operation.

Class GetConfigurationRequest

Container for the parameters to the GetConfiguration operation. Retrieves a TagKey configuration from an account.

Class GetConfigurationResponse

This is the response object from the GetConfiguration operation.

Class Integrations

The information about the service integration.

Class InternalServerException

The service is experiencing internal problems.

Class ListApplicationsRequest

Container for the parameters to the ListApplications operation. Retrieves a list of all of your applications. Results are paginated.

Class ListApplicationsResponse

This is the response object from the ListApplications operation.

Class ListAssociatedAttributeGroupsRequest

Container for the parameters to the ListAssociatedAttributeGroups operation. Lists all attribute groups that are associated with specified application. Results are paginated.

Class ListAssociatedAttributeGroupsResponse

This is the response object from the ListAssociatedAttributeGroups operation.

Class ListAssociatedResourcesRequest

Container for the parameters to the ListAssociatedResources operation. 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.

Class ListAssociatedResourcesResponse

This is the response object from the ListAssociatedResources operation.

Class ListAttributeGroupsForApplicationRequest

Container for the parameters to the ListAttributeGroupsForApplication operation. Lists the details of all attribute groups associated with a specific application. The results display in pages.

Class ListAttributeGroupsForApplicationResponse

This is the response object from the ListAttributeGroupsForApplication operation.

Class ListAttributeGroupsRequest

Container for the parameters to the ListAttributeGroups operation. Lists all attribute groups which you have access to. Results are paginated.

Class ListAttributeGroupsResponse

This is the response object from the ListAttributeGroups operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Lists all of the tags on the resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class PutConfigurationRequest

Container for the parameters to the PutConfiguration operation. Associates a TagKey configuration to an account.

Class PutConfigurationResponse

This is the response object from the PutConfiguration operation.

Class Resource

The information about the resource.

Class ResourceDetails

The details related to the resource.

Class ResourceGroup

The information about the resource group integration.

Class ResourceInfo

The information about the resource.

Class ResourceIntegrations

The service integration information about the resource.

Class ResourceNotFoundException

The specified resource does not exist.

Class ResourcesListItem

The resource in a list of resources.

Class ServiceQuotaExceededException

The maximum number of resources per account has been reached.

Class SyncResourceRequest

Container for the parameters to the SyncResource operation. 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.

Class SyncResourceResponse

This is the response object from the SyncResource operation.

Class TagQueryConfiguration

The definition of tagQuery. Specifies which resources are associated with an application.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

The maximum number of API requests has been exceeded.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from a resource.

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

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. Updates an existing application with new attributes.

Class UpdateApplicationResponse

This is the response object from the UpdateApplication operation.

Class UpdateAttributeGroupRequest

Container for the parameters to the UpdateAttributeGroup operation. Updates an existing attribute group with new details.

Class UpdateAttributeGroupResponse

This is the response object from the UpdateAttributeGroup operation.

Class ValidationException

The request has invalid or missing parameters.

Interfaces

NameDescription
Interface IAppRegistryPaginatorFactory

Paginators for the AppRegistry service

Interface IListApplicationsPaginator

Paginator for the ListApplications operation

Interface IListAssociatedAttributeGroupsPaginator

Paginator for the ListAssociatedAttributeGroups operation

Interface IListAssociatedResourcesPaginator

Paginator for the ListAssociatedResources operation

Interface IListAttributeGroupsForApplicationPaginator

Paginator for the ListAttributeGroupsForApplication operation

Interface IListAttributeGroupsPaginator

Paginator for the ListAttributeGroups operation