Class: AWS.ServiceCatalogAppRegistry

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK | RESOURCE_TAG_VALUE, /* required */
  options: [
    APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG,
    /* more items */
  ]
};
servicecatalogappregistry.associateResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

  • resourceType — (String)

    The type of resource of which the application will be associated.

    Possible values include:
    • "CFN_STACK"
    • "RESOURCE_TAG_VALUE"
  • resource — (String)

    The name or ID of the resource of which the application will be associated.

  • options — (Array<String>)

    Determines whether an application tag is applied or skipped.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • applicationArn — (String)

      The Amazon resource name (ARN) of the application that was augmented with attributes.

    • resourceArn — (String)

      The Amazon resource name (ARN) that specifies the resource.

    • options — (Array<String>)

      Determines whether an application tag is applied or skipped.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
servicecatalogappregistry.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the application. The name must be unique in the region in which you are creating the application.

  • description — (String)

    The description of the application.

  • tags — (map<String>)

    Key-value pairs you can use to associate with the application.

  • clientToken — (String)

    A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • application — (map)

      Information about the application.

      • id — (String)

        The identifier of the application.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the application across services.

      • name — (String)

        The name of the application. The name must be unique in the region in which you are creating the application.

      • description — (String)

        The description of the application.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was last updated.

      • tags — (map<String>)

        Key-value pairs you can use to associate with the application.

      • applicationTag — (map<String>)

        A key-value pair that identifies an associated resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attributes: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
servicecatalogappregistry.createAttributeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name of the attribute group.

  • description — (String)

    The description of the attribute group that the user provides.

  • attributes — (String)

    A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

  • tags — (map<String>)

    Key-value pairs you can use to associate with the attribute group.

  • clientToken — (String)

    A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroup — (map)

      Information about the attribute group.

      • id — (String)

        The globally unique attribute group identifier of the attribute group.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the attribute group across services.

      • name — (String)

        The name of the attribute group.

      • description — (String)

        The description of the attribute group that the user provides.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

      • tags — (map<String>)

        Key-value pairs you can use to associate with the attribute group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • application — (map)

      Information about the deleted application.

      • id — (String)

        The identifier of the application.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the application across services.

      • name — (String)

        The name of the application. The name must be unique in the region in which you are creating the application.

      • description — (String)

        The description of the application.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attributeGroup: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.deleteAttributeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • attributeGroup — (String)

    The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroup — (map)

      Information about the deleted attribute group.

      • id — (String)

        The globally unique attribute group identifier of the attribute group.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the attribute group across services.

      • name — (String)

        The name of the attribute group.

      • description — (String)

        The description of the attribute group that the user provides.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

      • createdBy — (String)

        The service principal that created the attribute group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  attributeGroup: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.disassociateAttributeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

  • attributeGroup — (String)

    The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • applicationArn — (String)

      The Amazon resource name (ARN) that specifies the application.

    • attributeGroupArn — (String)

      The Amazon resource name (ARN) that specifies the attribute group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK | RESOURCE_TAG_VALUE /* required */
};
servicecatalogappregistry.disassociateResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name or ID of the application.

  • resourceType — (String)

    The type of the resource that is being disassociated.

    Possible values include:
    • "CFN_STACK"
    • "RESOURCE_TAG_VALUE"
  • resource — (String)

    The name or ID of the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • applicationArn — (String)

      The Amazon resource name (ARN) that specifies the application.

    • resourceArn — (String)

      The Amazon resource name (ARN) that specifies the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The identifier of the application.

    • arn — (String)

      The Amazon resource name (ARN) that specifies the application across services.

    • name — (String)

      The name of the application. The name must be unique in the region in which you are creating the application.

    • description — (String)

      The description of the application.

    • creationTime — (Date)

      The ISO-8601 formatted timestamp of the moment when the application was created.

    • lastUpdateTime — (Date)

      The ISO-8601 formatted timestamp of the moment when the application was last updated.

    • associatedResourceCount — (Integer)

      The number of top-level resources that were registered as part of this application.

    • tags — (map<String>)

      Key-value pairs associated with the application.

    • integrations — (map)

      The information about the integration of the application with other services, such as Resource Groups.

      • resourceGroup — (map)

        The information about the resource group integration.

        • state — (String)

          The state of the propagation process for the resource group. The states includes:

          CREATING if the resource group is in the process of being created.

          CREATE_COMPLETE if the resource group was created successfully.

          CREATE_FAILED if the resource group failed to be created.

          UPDATING if the resource group is in the process of being updated.

          UPDATE_COMPLETE if the resource group updated successfully.

          UPDATE_FAILED if the resource group could not update successfully.

          Possible values include:
          • "CREATING"
          • "CREATE_COMPLETE"
          • "CREATE_FAILED"
          • "UPDATING"
          • "UPDATE_COMPLETE"
          • "UPDATE_FAILED"
        • arn — (String)

          The Amazon resource name (ARN) of the resource group.

        • errorMessage — (String)

          The error message that generates when the propagation process for the resource group fails.

      • applicationTagResourceGroup — (map)

        The information about the resource group integration.

        • state — (String)

          The state of the propagation process for the resource group. The states includes:

          CREATING if the resource group is in the process of being created.

          CREATE_COMPLETE if the resource group was created successfully.

          CREATE_FAILED if the resource group failed to be created.

          UPDATING if the resource group is in the process of being updated.

          UPDATE_COMPLETE if the resource group updated successfully.

          UPDATE_FAILED if the resource group could not update successfully.

          Possible values include:
          • "CREATING"
          • "CREATE_COMPLETE"
          • "CREATE_FAILED"
          • "UPDATING"
          • "UPDATE_COMPLETE"
          • "UPDATE_FAILED"
        • arn — (String)

          The Amazon resource name (ARN) of the resource group.

        • errorMessage — (String)

          The error message that generates when the propagation process for the resource group fails.

    • applicationTag — (map<String>)

      A key-value pair that identifies an associated resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK | RESOURCE_TAG_VALUE, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceTagStatus: [
    SUCCESS | FAILED | IN_PROGRESS | SKIPPED,
    /* more items */
  ]
};
servicecatalogappregistry.getAssociatedResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

  • resourceType — (String)

    The type of resource associated with the application.

    Possible values include:
    • "CFN_STACK"
    • "RESOURCE_TAG_VALUE"
  • resource — (String)

    The name or ID of the resource associated with the application.

  • nextToken — (String)

    A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

  • resourceTagStatus — (Array<String>)

    States whether an application tag is applied, not applied, in the process of being applied, or skipped.

  • maxResults — (Integer)

    The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • resource — (map)

      The resource associated with the application.

      • name — (String)

        The name of the resource.

      • arn — (String)

        The Amazon resource name (ARN) of the resource.

      • associationTime — (Date)

        The time the resource was associated with the application.

      • integrations — (map)

        The service integration information about the resource.

        • resourceGroup — (map)

          The information about the integration of Resource Groups.

          • state — (String)

            The state of the propagation process for the resource group. The states includes:

            CREATING if the resource group is in the process of being created.

            CREATE_COMPLETE if the resource group was created successfully.

            CREATE_FAILED if the resource group failed to be created.

            UPDATING if the resource group is in the process of being updated.

            UPDATE_COMPLETE if the resource group updated successfully.

            UPDATE_FAILED if the resource group could not update successfully.

            Possible values include:
            • "CREATING"
            • "CREATE_COMPLETE"
            • "CREATE_FAILED"
            • "UPDATING"
            • "UPDATE_COMPLETE"
            • "UPDATE_FAILED"
          • arn — (String)

            The Amazon resource name (ARN) of the resource group.

          • errorMessage — (String)

            The error message that generates when the propagation process for the resource group fails.

    • options — (Array<String>)

      Determines whether an application tag is applied or skipped.

    • applicationTagResult — (map)

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

      • applicationTagStatus — (String)

        The application tag is in the process of being applied to a resource, was successfully applied to a resource, or failed to apply to a resource.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESS"
        • "FAILURE"
      • errorMessage — (String)

        The message returned if the call fails.

      • resources — (Array<map>)

        The resources associated with an application

        • resourceArn — (String)

          The Amazon resource name (ARN) of the resource.

        • errorMessage — (String)

          The message returned if the call fails.

        • status — (String)

          The status of the list item.

        • resourceType — (String)

          Provides information about the AppRegistry resource type.

      • nextToken — (String)

        A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attributeGroup: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.getAttributeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • attributeGroup — (String)

    The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • id — (String)

      The identifier of the attribute group.

    • arn — (String)

      The Amazon resource name (ARN) that specifies the attribute group across services.

    • name — (String)

      The name of the attribute group.

    • description — (String)

      The description of the attribute group that the user provides.

    • attributes — (String)

      A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

    • creationTime — (Date)

      The ISO-8601 formatted timestamp of the moment the attribute group was created.

    • lastUpdateTime — (Date)

      The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

    • tags — (map<String>)

      Key-value pairs associated with the attribute group.

    • createdBy — (String)

      The service principal that created the attribute group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

servicecatalogappregistry.getConfiguration(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configuration — (map)

      Retrieves TagKey configuration from an account.

      • tagQueryConfiguration — (map)

        Includes the definition of a tagQuery.

        • tagKey — (String)

          Condition in the IAM policy that associates resources to an application.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
servicecatalogappregistry.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token to use to get the next page of results after a previous API call.

  • maxResults — (Integer)

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • applications — (Array<map>)

      This list of applications.

      • id — (String)

        The identifier of the application.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the application across services.

      • name — (String)

        The name of the application. The name must be unique in the region in which you are creating the application.

      • description — (String)

        The description of the application.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was last updated.

    • nextToken — (String)

      The token to use to get the next page of results after a previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
servicecatalogappregistry.listAssociatedAttributeGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name or ID of the application.

  • nextToken — (String)

    The token to use to get the next page of results after a previous API call.

  • maxResults — (Integer)

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroups — (Array<String>)

      A list of attribute group IDs.

    • nextToken — (String)

      The token to use to get the next page of results after a previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
servicecatalogappregistry.listAssociatedResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application.

  • nextToken — (String)

    The token to use to get the next page of results after a previous API call.

  • maxResults — (Integer)

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • resources — (Array<map>)

      Information about the resources.

      • name — (String)

        The name of the resource.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the resource across services.

      • resourceType — (String)

        Provides information about the Service Catalog App Registry resource type.

        Possible values include:
        • "CFN_STACK"
        • "RESOURCE_TAG_VALUE"
      • resourceDetails — (map)

        The details related to the resource.

        • tagValue — (String)

          The value of the tag.

      • options — (Array<String>)

        Determines whether an application tag is applied or skipped.

    • nextToken — (String)

      The token to use to get the next page of results after a previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
servicecatalogappregistry.listAttributeGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token to use to get the next page of results after a previous API call.

  • maxResults — (Integer)

    The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroups — (Array<map>)

      This list of attribute groups.

      • id — (String)

        The globally unique attribute group identifier of the attribute group.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the attribute group across services.

      • name — (String)

        The name of the attribute group.

      • description — (String)

        The description of the attribute group that the user provides.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

      • createdBy — (String)

        The service principal that created the attribute group.

    • nextToken — (String)

      The token to use to get the next page of results after a previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
servicecatalogappregistry.listAttributeGroupsForApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name or ID of the application.

  • nextToken — (String)

    This token retrieves the next page of results after a previous API call.

  • maxResults — (Integer)

    The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroupsDetails — (Array<map>)

      The details related to a specific attribute group.

      • id — (String)

        The unique identifier of the attribute group.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the attribute group.

      • name — (String)

        This field is no longer supported. We recommend you don't use the field when using ListAttributeGroupsForApplication.

        The name of the attribute group.

      • createdBy — (String)

        The service principal that created the attribute group.

    • nextToken — (String)

      The token to use to get the next page of results after a previous API call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon resource name (ARN) that specifies the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The tags on the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configuration: { /* required */
    tagQueryConfiguration: {
      tagKey: 'STRING_VALUE'
    }
  }
};
servicecatalogappregistry.putConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configuration — (map)

    Associates a TagKey configuration to an account.

    • tagQueryConfiguration — (map)

      Includes the definition of a tagQuery.

      • tagKey — (String)

        Condition in the IAM policy that associates resources to an application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK | RESOURCE_TAG_VALUE /* required */
};
servicecatalogappregistry.syncResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceType — (String)

    The type of resource of which the application will be associated.

    Possible values include:
    • "CFN_STACK"
    • "RESOURCE_TAG_VALUE"
  • resource — (String)

    An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • applicationArn — (String)

      The Amazon resource name (ARN) that specifies the application.

    • resourceArn — (String)

      The Amazon resource name (ARN) that specifies the resource.

    • actionTaken — (String)

      The results of the output if an application is associated with an ARN value, which could be syncStarted or None.

      Possible values include:
      • "START_SYNC"
      • "NO_ACTION"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
servicecatalogappregistry.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon resource name (ARN) that specifies the resource.

  • tags — (map<String>)

    The new or modified tags for the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
servicecatalogappregistry.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The Amazon resource name (ARN) that specifies the resource.

  • tagKeys — (Array<String>)

    A list of the tag keys to remove from the specified resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  application: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
servicecatalogappregistry.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • application — (String)

    The name, ID, or ARN of the application that will be updated.

  • name — (String)

    Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.

  • description — (String)

    The new description of the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • application — (map)

      The updated information of the application.

      • id — (String)

        The identifier of the application.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the application across services.

      • name — (String)

        The name of the application. The name must be unique in the region in which you are creating the application.

      • description — (String)

        The description of the application.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment when the application was last updated.

      • tags — (map<String>)

        Key-value pairs you can use to associate with the application.

      • applicationTag — (map<String>)

        A key-value pair that identifies an associated resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  attributeGroup: 'STRING_VALUE', /* required */
  attributes: 'STRING_VALUE',
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
servicecatalogappregistry.updateAttributeGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • attributeGroup — (String)

    The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

  • name — (String)

    Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates.

  • description — (String)

    The description of the attribute group that the user provides.

  • attributes — (String)

    A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • attributeGroup — (map)

      The updated information of the attribute group.

      • id — (String)

        The globally unique attribute group identifier of the attribute group.

      • arn — (String)

        The Amazon resource name (ARN) that specifies the attribute group across services.

      • name — (String)

        The name of the attribute group.

      • description — (String)

        The description of the attribute group that the user provides.

      • creationTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was created.

      • lastUpdateTime — (Date)

        The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

      • tags — (map<String>)

        Key-value pairs you can use to associate with the attribute group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.