AWS.ServiceCatalogAppRegistry — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

servicecatalogappregistry

API Version:

2020-06-24

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using ServiceCatalogAppRegistry

var servicecatalogappregistry = new AWS.ServiceCatalogAppRegistry();
servicecatalogappregistry.associateAttributeGroup(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ServiceCatalogAppRegistry object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var servicecatalogappregistry = new AWS.ServiceCatalogAppRegistry({apiVersion: '2020-06-24'});

You can also set the API version globally in AWS.config.apiVersions using the servicecatalogappregistry service identifier:

AWS.config.apiVersions = {
  servicecatalogappregistry: '2020-06-24',
  // other service API versions
};

var servicecatalogappregistry = new AWS.ServiceCatalogAppRegistry();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ServiceCatalogAppRegistry(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateAttributeGroup(params = {}, callback) ⇒ AWS.Request

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

associateResource(params = {}, callback) ⇒ AWS.Request

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.

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.

Note: 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.

createApplication(params = {}, callback) ⇒ AWS.Request

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

createAttributeGroup(params = {}, callback) ⇒ AWS.Request

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

deleteApplication(params = {}, callback) ⇒ AWS.Request

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

deleteAttributeGroup(params = {}, callback) ⇒ AWS.Request

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

disassociateAttributeGroup(params = {}, callback) ⇒ AWS.Request

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

disassociateResource(params = {}, callback) ⇒ AWS.Request

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.

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.

Note: 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.

getApplication(params = {}, callback) ⇒ AWS.Request

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

getAssociatedResource(params = {}, callback) ⇒ AWS.Request

Gets the resource associated with the application.

getAttributeGroup(params = {}, callback) ⇒ AWS.Request

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

getConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves a TagKey configuration from an account.

listApplications(params = {}, callback) ⇒ AWS.Request

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

listAssociatedAttributeGroups(params = {}, callback) ⇒ AWS.Request

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

listAssociatedResources(params = {}, callback) ⇒ AWS.Request

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

Note: 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.

listAttributeGroups(params = {}, callback) ⇒ AWS.Request

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

listAttributeGroupsForApplication(params = {}, callback) ⇒ AWS.Request

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all of the tags on the resource.

putConfiguration(params = {}, callback) ⇒ AWS.Request

Associates a TagKey configuration to an account.

syncResource(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource.

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

updateApplication(params = {}, callback) ⇒ AWS.Request

Updates an existing application with new attributes.

updateAttributeGroup(params = {}, callback) ⇒ AWS.Request

Updates an existing attribute group with new details.