You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ServiceCatalogAppRegistry

Inherits:
AWS.Service show all
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();

Version:

  • 2020-06-24

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a ServiceCatalogAppRegistry object

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

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.ServiceCatalogAppRegistry.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.ServiceCatalogAppRegistry.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ServiceCatalogAppRegistry.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    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.

Service Reference:

Examples:

Calling the associateAttributeGroup operation

var params = {
  application: 'STRING_VALUE', /* required */
  attributeGroup: 'STRING_VALUE' /* required */
};
servicecatalogappregistry.associateAttributeGroup(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.

    • attributeGroup — (String)

      The name or ID 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) of the application that was augmented with attributes.

      • attributeGroupArn — (String)

        The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.

Returns:

  • (AWS.Request) —

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

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

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

Service Reference:

Examples:

Calling the associateResource operation

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK /* required */
};
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 or ID of the application.

    • resourceType — (String)

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

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

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

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.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the createApplication operation

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.

Returns:

  • (AWS.Request) —

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

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.

Service Reference:

Examples:

Calling the createAttributeGroup operation

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.

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

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

Service Reference:

Examples:

Calling the deleteApplication operation

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 or ID 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.

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

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

Service Reference:

Examples:

Calling the deleteAttributeGroup operation

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 or ID 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.

Returns:

  • (AWS.Request) —

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

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.

Service Reference:

Examples:

Calling the disassociateAttributeGroup operation

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 or ID of the application.

    • attributeGroup — (String)

      The name or ID 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.

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

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

Service Reference:

Examples:

Calling the disassociateResource operation

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK /* 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 — (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.

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

Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by 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.

Service Reference:

Examples:

Calling the getApplication operation

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 or ID 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.

Returns:

  • (AWS.Request) —

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

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

Gets the resource associated with the application.

Service Reference:

Examples:

Calling the getAssociatedResource operation

var params = {
  application: 'STRING_VALUE', /* required */
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK /* required */
};
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 or ID of the application.

    • resourceType — (String)

      The type of resource associated with the application.

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

      The name or ID of the resource associated with 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:

      • 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.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the getAttributeGroup operation

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 or ID 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.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the listApplications operation

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.

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

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

Service Reference:

Examples:

Calling the listAssociatedAttributeGroups operation

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.

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

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

Service Reference:

Examples:

Calling the listAssociatedResources operation

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

      • 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.

      • 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.

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

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

Service Reference:

Examples:

Calling the listAttributeGroups operation

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.

      • 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.

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

Lists all of the tags on the resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

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.

Service Reference:

Examples:

Calling the syncResource operation

var params = {
  resource: 'STRING_VALUE', /* required */
  resourceType: CFN_STACK /* 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 — (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.

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.

Service Reference:

Examples:

Calling the tagResource operation

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.

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

Removes tags from a resource.

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

Service Reference:

Examples:

Calling the untagResource operation

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.

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

Updates an existing application with new attributes.

Service Reference:

Examples:

Calling the updateApplication operation

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 or ID of the application that will be updated.

    • name — (String)

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

    • 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.

Returns:

  • (AWS.Request) —

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

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

Updates an existing attribute group with new details.

Service Reference:

Examples:

Calling the updateAttributeGroup operation

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 or ID of the attribute group that holds the attributes to describe the application.

    • name — (String)

      The new name of the attribute group. The name must be unique in the region in which you are updating 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.

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.