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.

Interface for accessing AppRegistry

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.

Inheritance Hierarchy

Amazon.AppRegistry.IAmazonAppRegistry

Namespace: Amazon.AppRegistry
Assembly: AWSSDK.AppRegistry.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonAppRegistry
         IAmazonService, IDisposable

The IAmazonAppRegistry type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.AppRegistry.Model.IAppRegistryPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateAttributeGroup(AssociateAttributeGroupRequest)

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.

Public Method AssociateAttributeGroupAsync(AssociateAttributeGroupRequest, CancellationToken)

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.

Public Method AssociateResource(AssociateResourceRequest)

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.

Public Method AssociateResourceAsync(AssociateResourceRequest, CancellationToken)

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.

Public Method CreateApplication(CreateApplicationRequest)

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

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

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

Public Method CreateAttributeGroup(CreateAttributeGroupRequest)

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.

Public Method CreateAttributeGroupAsync(CreateAttributeGroupRequest, CancellationToken)

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.

Public Method DeleteApplication(DeleteApplicationRequest)

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.

Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken)

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.

Public Method DeleteAttributeGroup(DeleteAttributeGroupRequest)

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

Public Method DeleteAttributeGroupAsync(DeleteAttributeGroupRequest, CancellationToken)

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

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateAttributeGroup(DisassociateAttributeGroupRequest)

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.

Public Method DisassociateAttributeGroupAsync(DisassociateAttributeGroupRequest, CancellationToken)

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.

Public Method DisassociateResource(DisassociateResourceRequest)

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.

Public Method DisassociateResourceAsync(DisassociateResourceRequest, CancellationToken)

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.

Public Method GetApplication(GetApplicationRequest)

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.

Public Method GetApplicationAsync(GetApplicationRequest, CancellationToken)

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.

Public Method GetAssociatedResource(GetAssociatedResourceRequest)

Gets the resource associated with the application.

Public Method GetAssociatedResourceAsync(GetAssociatedResourceRequest, CancellationToken)

Gets the resource associated with the application.

Public Method GetAttributeGroup(GetAttributeGroupRequest)

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

Public Method GetAttributeGroupAsync(GetAttributeGroupRequest, CancellationToken)

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

Public Method GetConfiguration(GetConfigurationRequest)

Retrieves a TagKey configuration from an account.

Public Method GetConfigurationAsync(GetConfigurationRequest, CancellationToken)

Retrieves a TagKey configuration from an account.

Public Method ListApplications(ListApplicationsRequest)

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

Public Method ListApplicationsAsync(ListApplicationsRequest, CancellationToken)

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

Public Method ListAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest)

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

Public Method ListAssociatedAttributeGroupsAsync(ListAssociatedAttributeGroupsRequest, CancellationToken)

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

Public Method ListAssociatedResources(ListAssociatedResourcesRequest)

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.

Public Method ListAssociatedResourcesAsync(ListAssociatedResourcesRequest, CancellationToken)

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.

Public Method ListAttributeGroups(ListAttributeGroupsRequest)

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

Public Method ListAttributeGroupsAsync(ListAttributeGroupsRequest, CancellationToken)

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

Public Method ListAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest)

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

Public Method ListAttributeGroupsForApplicationAsync(ListAttributeGroupsForApplicationRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all of the tags on the resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists all of the tags on the resource.

Public Method PutConfiguration(PutConfigurationRequest)

Associates a TagKey configuration to an account.

Public Method PutConfigurationAsync(PutConfigurationRequest, CancellationToken)

Associates a TagKey configuration to an account.

Public Method SyncResource(SyncResourceRequest)

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.

Public Method SyncResourceAsync(SyncResourceRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

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.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Removes tags from a resource.

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from a resource.

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

Public Method UpdateApplication(UpdateApplicationRequest)

Updates an existing application with new attributes.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Updates an existing application with new attributes.

Public Method UpdateAttributeGroup(UpdateAttributeGroupRequest)

Updates an existing attribute group with new details.

Public Method UpdateAttributeGroupAsync(UpdateAttributeGroupRequest, CancellationToken)

Updates an existing attribute group with new details.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5