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

Inherits:
AWS.Service show all
Identifier:
servicecatalog
API Version:
2015-12-10
Defined in:
(unknown)

Overview

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

Service Description

AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in AWS Service Catalog Concepts.

Sending a Request Using ServiceCatalog

var servicecatalog = new AWS.ServiceCatalog();
servicecatalog.associateBudgetWithResource(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 ServiceCatalog object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var servicecatalog = new AWS.ServiceCatalog({apiVersion: '2015-12-10'});

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

AWS.config.apiVersions = {
  servicecatalog: '2015-12-10',
  // other service API versions
};

var servicecatalog = new AWS.ServiceCatalog();

Version:

  • 2015-12-10

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.ServiceCatalog(options = {}) ⇒ Object

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

Examples:

Constructing a ServiceCatalog object

var servicecatalog = new AWS.ServiceCatalog({apiVersion: '2015-12-10'});

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.ServiceCatalog.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ServiceCatalog.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

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

Accepts an offer to share the specified portfolio.

Service Reference:

Examples:

Calling the acceptPortfolioShare operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PortfolioShareType: IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS
};
servicecatalog.acceptPortfolioShare(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • PortfolioShareType — (String)

      The type of shared portfolios to accept. The default is to accept imported portfolios.

      • AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your organization.

      • IMPORTED - Accept imported portfolios.

      • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      For example, aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

      Possible values include:
      • "IMPORTED"
      • "AWS_SERVICECATALOG"
      • "AWS_ORGANIZATIONS"

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.

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

Associates the specified budget with the specified resource.

Service Reference:

Examples:

Calling the associateBudgetWithResource operation

var params = {
  BudgetName: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
servicecatalog.associateBudgetWithResource(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: {}) —
    • BudgetName — (String)

      The name of the budget you want to associate.

    • ResourceId — (String)

      The resource identifier. Either a portfolio-id or a product-id.

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.

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

Associates the specified principal ARN with the specified portfolio.

Service Reference:

Examples:

Calling the associatePrincipalWithPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  PrincipalARN: 'STRING_VALUE', /* required */
  PrincipalType: IAM, /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.associatePrincipalWithPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • PrincipalARN — (String)

      The ARN of the principal (IAM user, role, or group).

    • PrincipalType — (String)

      The principal type. The supported value is IAM.

      Possible values include:
      • "IAM"

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.

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

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the associateProductWithPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  SourcePortfolioId: 'STRING_VALUE'
};
servicecatalog.associateProductWithPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • PortfolioId — (String)

      The portfolio identifier.

    • SourcePortfolioId — (String)

      The identifier of the source portfolio.

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.

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

Associates a self-service action with a provisioning artifact.

Service Reference:

Examples:

Calling the associateServiceActionWithProvisioningArtifact operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.associateServiceActionWithProvisioningArtifact(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: {}) —
    • ProductId — (String)

      The product identifier. For example, prod-abcdzk7xy33qa.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    • ServiceActionId — (String)

      The self-service action identifier. For example, act-fs7abcd89wxyz.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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.

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

Associate the specified TagOption with the specified portfolio or product.

Service Reference:

Examples:

Calling the associateTagOptionWithResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagOptionId: 'STRING_VALUE' /* required */
};
servicecatalog.associateTagOptionWithResource(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: {}) —
    • ResourceId — (String)

      The resource identifier.

    • TagOptionId — (String)

      The TagOption identifier.

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.

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

Associates multiple self-service actions with provisioning artifacts.

Service Reference:

Examples:

Calling the batchAssociateServiceActionWithProvisioningArtifact operation

var params = {
  ServiceActionAssociations: [ /* required */
    {
      ProductId: 'STRING_VALUE', /* required */
      ProvisioningArtifactId: 'STRING_VALUE', /* required */
      ServiceActionId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.batchAssociateServiceActionWithProvisioningArtifact(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: {}) —
    • ServiceActionAssociations — (Array<map>)

      One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

      • ServiceActionId — required — (String)

        The self-service action identifier. For example, act-fs7abcd89wxyz.

      • ProductId — required — (String)

        The product identifier. For example, prod-abcdzk7xy33qa.

      • ProvisioningArtifactId — required — (String)

        The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • FailedServiceActionAssociations — (Array<map>)

        An object that contains a list of errors, along with information to help you identify the self-service action.

        • ServiceActionId — (String)

          The self-service action identifier. For example, act-fs7abcd89wxyz.

        • ProductId — (String)

          The product identifier. For example, prod-abcdzk7xy33qa.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

        • ErrorCode — (String)

          The error code. Valid values are listed below.

          Possible values include:
          • "DUPLICATE_RESOURCE"
          • "INTERNAL_FAILURE"
          • "LIMIT_EXCEEDED"
          • "RESOURCE_NOT_FOUND"
          • "THROTTLING"
        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request) —

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

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

Disassociates a batch of self-service actions from the specified provisioning artifact.

Service Reference:

Examples:

Calling the batchDisassociateServiceActionFromProvisioningArtifact operation

var params = {
  ServiceActionAssociations: [ /* required */
    {
      ProductId: 'STRING_VALUE', /* required */
      ProvisioningArtifactId: 'STRING_VALUE', /* required */
      ServiceActionId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.batchDisassociateServiceActionFromProvisioningArtifact(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: {}) —
    • ServiceActionAssociations — (Array<map>)

      One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

      • ServiceActionId — required — (String)

        The self-service action identifier. For example, act-fs7abcd89wxyz.

      • ProductId — required — (String)

        The product identifier. For example, prod-abcdzk7xy33qa.

      • ProvisioningArtifactId — required — (String)

        The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • FailedServiceActionAssociations — (Array<map>)

        An object that contains a list of errors, along with information to help you identify the self-service action.

        • ServiceActionId — (String)

          The self-service action identifier. For example, act-fs7abcd89wxyz.

        • ProductId — (String)

          The product identifier. For example, prod-abcdzk7xy33qa.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

        • ErrorCode — (String)

          The error code. Valid values are listed below.

          Possible values include:
          • "DUPLICATE_RESOURCE"
          • "INTERNAL_FAILURE"
          • "LIMIT_EXCEEDED"
          • "RESOURCE_NOT_FOUND"
          • "THROTTLING"
        • ErrorMessage — (String)

          A text description of the error.

Returns:

  • (AWS.Request) —

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

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

Copies the specified source product to the specified target product or a new product.

You can copy a product to the same account or another account. You can copy a product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Service Reference:

Examples:

Calling the copyProduct operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  SourceProductArn: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  CopyOptions: [
    CopyTags,
    /* more items */
  ],
  SourceProvisioningArtifactIdentifiers: [
    {
      '<ProvisioningArtifactPropertyName>': 'STRING_VALUE',
      /* '<ProvisioningArtifactPropertyName>': ... */
    },
    /* more items */
  ],
  TargetProductId: 'STRING_VALUE',
  TargetProductName: 'STRING_VALUE'
};
servicecatalog.copyProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • SourceProductArn — (String)

      The Amazon Resource Name (ARN) of the source product.

    • TargetProductId — (String)

      The identifier of the target product. By default, a new product is created.

    • TargetProductName — (String)

      A name for the target product. The default is the name of the source product.

    • SourceProvisioningArtifactIdentifiers — (Array<map<String>>)

      The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

    • CopyOptions — (Array<String>)

      The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • CopyProductToken — (String)

        The token to use to track the progress of the operation.

Returns:

  • (AWS.Request) —

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

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

Creates a constraint.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the createConstraint operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Parameters: 'STRING_VALUE', /* required */
  PortfolioId: 'STRING_VALUE', /* required */
  ProductId: 'STRING_VALUE', /* required */
  Type: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicecatalog.createConstraint(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • ProductId — (String)

      The product identifier.

    • Parameters — (String)

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can't use both.

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      Note: The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

    • Type — (String)

      The type of constraint.

      • LAUNCH

      • NOTIFICATION

      • RESOURCE_UPDATE

      • STACKSET

      • TEMPLATE

    • Description — (String)

      The description of the constraint.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • ConstraintDetail — (map)

        Information about the constraint.

        • ConstraintId — (String)

          The identifier of the constraint.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

        • ProductId — (String)

          The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

        • PortfolioId — (String)

          The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

      • ConstraintParameters — (String)

        The constraint parameters.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Creates a portfolio.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the createPortfolio operation

var params = {
  DisplayName: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE', /* required */
  ProviderName: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.createPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • DisplayName — (String)

      The name to use for display purposes.

    • Description — (String)

      The description of the portfolio.

    • ProviderName — (String)

      The name of the portfolio provider.

    • Tags — (Array<map>)

      One or more tags.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • PortfolioDetail — (map)

        Information about the portfolio.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

Returns:

  • (AWS.Request) —

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

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

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.

Service Reference:

Examples:

Calling the createPortfolioShare operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AccountId: 'STRING_VALUE',
  OrganizationNode: {
    Type: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT,
    Value: 'STRING_VALUE'
  },
  ShareTagOptions: true || false
};
servicecatalog.createPortfolioShare(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • AccountId — (String)

      The AWS account ID. For example, 123456789012.

    • OrganizationNode — (map)

      The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node an ListOrganizationPortfolioAccessd its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

      • Type — (String)

        The organization node type.

        Possible values include:
        • "ORGANIZATION"
        • "ORGANIZATIONAL_UNIT"
        • "ACCOUNT"
      • Value — (String)

        The identifier of the organization node.

    • ShareTagOptions — (Boolean)

      Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.

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:

      • PortfolioShareToken — (String)

        The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.

Returns:

  • (AWS.Request) —

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

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

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Service Reference:

Examples:

Calling the createProduct operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Owner: 'STRING_VALUE', /* required */
  ProductType: CLOUD_FORMATION_TEMPLATE | MARKETPLACE, /* required */
  ProvisioningArtifactParameters: { /* required */
    Info: { /* required */
      '<ProvisioningArtifactInfoKey>': 'STRING_VALUE',
      /* '<ProvisioningArtifactInfoKey>': ... */
    },
    Description: 'STRING_VALUE',
    DisableTemplateValidation: true || false,
    Name: 'STRING_VALUE',
    Type: CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR
  },
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Distributor: 'STRING_VALUE',
  SupportDescription: 'STRING_VALUE',
  SupportEmail: 'STRING_VALUE',
  SupportUrl: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.createProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Name — (String)

      The name of the product.

    • Owner — (String)

      The owner of the product.

    • Description — (String)

      The description of the product.

    • Distributor — (String)

      The distributor of the product.

    • SupportDescription — (String)

      The support information about the product.

    • SupportEmail — (String)

      The contact email for product support.

    • SupportUrl — (String)

      The contact URL for product support.

      ^https?:\/\// / is the pattern used to validate SupportUrl.

    • ProductType — (String)

      The type of product.

      Possible values include:
      • "CLOUD_FORMATION_TEMPLATE"
      • "MARKETPLACE"
    • Tags — (Array<map>)

      One or more tags.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • ProvisioningArtifactParameters — (map)

      The configuration of the provisioning artifact.

      • Name — (String)

        The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

      • Description — (String)

        The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

      • Info — required — (map<String>)

        Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

        The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

        "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

        ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

      • Type — (String)

        The type of provisioning artifact.

        • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

        • MARKETPLACE_AMI - AWS Marketplace AMI

        • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

        Possible values include:
        • "CLOUD_FORMATION_TEMPLATE"
        • "MARKETPLACE_AMI"
        • "MARKETPLACE_CAR"
      • DisableTemplateValidation — (Boolean)

        If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • ProductViewDetail — (map)

        Information about the product view.

        • ProductViewSummary — (map)

          Summary information about the product view.

          • Id — (String)

            The product view identifier.

          • ProductId — (String)

            The product identifier.

          • Name — (String)

            The name of the product.

          • Owner — (String)

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription — (String)

            Short description of the product.

          • Type — (String)

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

            Possible values include:
            • "CLOUD_FORMATION_TEMPLATE"
            • "MARKETPLACE"
          • Distributor — (String)

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath — (Boolean)

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail — (String)

            The email contact information to obtain support for this Product.

          • SupportDescription — (String)

            The description of the support for this Product.

          • SupportUrl — (String)

            The URL information to obtain support for this Product.

        • Status — (String)

          The status of the product.

          • AVAILABLE - The product is ready for use.

          • CREATING - Product creation has started; the product is not ready for use.

          • FAILED - An action failed.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
        • ProductARN — (String)

          The ARN of the product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

      • ProvisioningArtifactDetail — (map)

        Information about the provisioning artifact.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • Type — (String)

          The type of provisioning artifact.

          • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

          • MARKETPLACE_AMI - AWS Marketplace AMI

          • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE_AMI"
          • "MARKETPLACE_CAR"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • Tags — (Array<map>)

        Information about the tags associated with the product.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

Returns:

  • (AWS.Request) —

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

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

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Service Reference:

Examples:

Calling the createProvisionedProductPlan operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  PlanName: 'STRING_VALUE', /* required */
  PlanType: CLOUDFORMATION, /* required */
  ProductId: 'STRING_VALUE', /* required */
  ProvisionedProductName: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  NotificationArns: [
    'STRING_VALUE',
    /* more items */
  ],
  PathId: 'STRING_VALUE',
  ProvisioningParameters: [
    {
      Key: 'STRING_VALUE',
      UsePreviousValue: true || false,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.createProvisionedProductPlan(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PlanName — (String)

      The name of the plan.

    • PlanType — (String)

      The plan type.

      Possible values include:
      • "CLOUDFORMATION"
    • NotificationArns — (Array<String>)

      Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    • PathId — (String)

      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    • ProductId — (String)

      The product identifier.

    • ProvisionedProductName — (String)

      A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • ProvisioningParameters — (Array<map>)

      Parameters specified by the administrator that are required for provisioning the product.

      • Key — (String)

        The parameter key.

      • Value — (String)

        The parameter value.

      • UsePreviousValue — (Boolean)

        If set to true, Value is ignored and the previous parameter value is kept.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      One or more tags.

      If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

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:

      • PlanName — (String)

        The name of the plan.

      • PlanId — (String)

        The plan identifier.

      • ProvisionProductId — (String)

        The product identifier.

      • ProvisionedProductName — (String)

        The user-friendly name of the provisioned product.

      • ProvisioningArtifactId — (String)

        The identifier of the provisioning artifact.

Returns:

  • (AWS.Request) —

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

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

Creates a provisioning artifact (also known as a version) for the specified product.

You cannot create a provisioning artifact for a product that was shared with you.

The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

Service Reference:

Examples:

Calling the createProvisioningArtifact operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Parameters: { /* required */
    Info: { /* required */
      '<ProvisioningArtifactInfoKey>': 'STRING_VALUE',
      /* '<ProvisioningArtifactInfoKey>': ... */
    },
    Description: 'STRING_VALUE',
    DisableTemplateValidation: true || false,
    Name: 'STRING_VALUE',
    Type: CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR
  },
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.createProvisioningArtifact(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • Parameters — (map)

      The configuration for the provisioning artifact.

      • Name — (String)

        The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

      • Description — (String)

        The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

      • Info — required — (map<String>)

        Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]

        The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

        "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

        ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

      • Type — (String)

        The type of provisioning artifact.

        • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

        • MARKETPLACE_AMI - AWS Marketplace AMI

        • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

        Possible values include:
        • "CLOUD_FORMATION_TEMPLATE"
        • "MARKETPLACE_AMI"
        • "MARKETPLACE_CAR"
      • DisableTemplateValidation — (Boolean)

        If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • ProvisioningArtifactDetail — (map)

        Information about the provisioning artifact.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • Type — (String)

          The type of provisioning artifact.

          • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

          • MARKETPLACE_AMI - AWS Marketplace AMI

          • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE_AMI"
          • "MARKETPLACE_CAR"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • Info — (map<String>)

        Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].

        The URL of the CloudFormation template in Amazon S3, in JSON format.

        LoadTemplateFromURL

        Use the URL of the CloudFormation template in Amazon S3 in JSON format.

        ImportFromPhysicalId

        Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Creates a self-service action.

Service Reference:

Examples:

Calling the createServiceAction operation

var params = {
  Definition: { /* required */
    '<ServiceActionDefinitionKey>': 'STRING_VALUE',
    /* '<ServiceActionDefinitionKey>': ... */
  },
  DefinitionType: SSM_AUTOMATION, /* required */
  IdempotencyToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicecatalog.createServiceAction(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 self-service action name.

    • DefinitionType — (String)

      The service action definition type. For example, SSM_AUTOMATION.

      Possible values include:
      • "SSM_AUTOMATION"
    • Definition — (map<String>)

      The self-service action definition. Can be one of the following:

      Name

      The name of the AWS Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

      If you are using a shared SSM document, you must provide the ARN instead of the name.

      Version

      The AWS Systems Manager automation document version. For example, "Version": "1"

      AssumeRole

      The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

      To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

      Parameters

      The list of parameters in JSON format.

      For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

    • Description — (String)

      The self-service action description.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • ServiceActionDetail — (map)

        An object containing information about the self-service action.

        • ServiceActionSummary — (map)

          Summary information about the self-service action.

          • Id — (String)

            The self-service action identifier.

          • Name — (String)

            The self-service action name.

          • Description — (String)

            The self-service action description.

          • DefinitionType — (String)

            The self-service action definition type. For example, SSM_AUTOMATION.

            Possible values include:
            • "SSM_AUTOMATION"
        • Definition — (map<String>)

          A map that defines the self-service action.

Returns:

  • (AWS.Request) —

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

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

Creates a TagOption.

Service Reference:

Examples:

Calling the createTagOption operation

var params = {
  Key: 'STRING_VALUE', /* required */
  Value: 'STRING_VALUE' /* required */
};
servicecatalog.createTagOption(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: {}) —
    • Key — (String)

      The TagOption key.

    • Value — (String)

      The TagOption value.

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:

      • TagOptionDetail — (map)

        Information about the TagOption.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the deleteConstraint operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.deleteConstraint(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The identifier of the constraint.

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.

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

Deletes the specified portfolio.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the deletePortfolio operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.deletePortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The portfolio identifier.

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.

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

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

Service Reference:

Examples:

Calling the deletePortfolioShare operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AccountId: 'STRING_VALUE',
  OrganizationNode: {
    Type: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT,
    Value: 'STRING_VALUE'
  }
};
servicecatalog.deletePortfolioShare(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • AccountId — (String)

      The AWS account ID.

    • OrganizationNode — (map)

      The organization node to whom you are going to stop sharing.

      • Type — (String)

        The organization node type.

        Possible values include:
        • "ORGANIZATION"
        • "ORGANIZATIONAL_UNIT"
        • "ACCOUNT"
      • Value — (String)

        The identifier of the organization node.

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:

      • PortfolioShareToken — (String)

        The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

Returns:

  • (AWS.Request) —

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

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

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the deleteProduct operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.deleteProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The product identifier.

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.

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

Deletes the specified plan.

Service Reference:

Examples:

Calling the deleteProvisionedProductPlan operation

var params = {
  PlanId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  IgnoreErrors: true || false
};
servicecatalog.deleteProvisionedProductPlan(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PlanId — (String)

      The plan identifier.

    • IgnoreErrors — (Boolean)

      If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

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.

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

Deletes the specified provisioning artifact (also known as a version) for the specified product.

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

Service Reference:

Examples:

Calling the deleteProvisioningArtifact operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.deleteProvisioningArtifact(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

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.

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

Deletes a self-service action.

Service Reference:

Examples:

Calling the deleteServiceAction operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.deleteServiceAction(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: {}) —
    • Id — (String)

      The self-service action identifier. For example, act-fs7abcd89wxyz.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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.

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

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

Service Reference:

Examples:

Calling the deleteTagOption operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicecatalog.deleteTagOption(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: {}) —
    • Id — (String)

      The TagOption identifier.

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.

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

Gets information about the specified constraint.

Service Reference:

Examples:

Calling the describeConstraint operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describeConstraint(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The identifier of the constraint.

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:

      • ConstraintDetail — (map)

        Information about the constraint.

        • ConstraintId — (String)

          The identifier of the constraint.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

        • ProductId — (String)

          The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

        • PortfolioId — (String)

          The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

      • ConstraintParameters — (String)

        The constraint parameters.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Gets the status of the specified copy product operation.

Service Reference:

Examples:

Calling the describeCopyProductStatus operation

var params = {
  CopyProductToken: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describeCopyProductStatus(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • CopyProductToken — (String)

      The token for the copy product operation. This token is returned by CopyProduct.

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:

      • CopyProductStatus — (String)

        The status of the copy product operation.

        Possible values include:
        • "SUCCEEDED"
        • "IN_PROGRESS"
        • "FAILED"
      • TargetProductId — (String)

        The identifier of the copied product.

      • StatusDetail — (String)

        The status message.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the describePortfolio operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describePortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The portfolio identifier.

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:

      • PortfolioDetail — (map)

        Information about the portfolio.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

      • TagOptions — (Array<map>)

        Information about the TagOptions associated with the portfolio.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

      • Budgets — (Array<map>)

        Information about the associated budgets.

        • BudgetName — (String)

          Name of the associated budget.

Returns:

  • (AWS.Request) —

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

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

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The PortfolioId and Type parameters are both required.

Service Reference:

Examples:

Calling the describePortfolioShares operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  Type: ACCOUNT | ORGANIZATION | ORGANIZATIONAL_UNIT | ORGANIZATION_MEMBER_ACCOUNT, /* required */
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.describePortfolioShares(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: {}) —
    • PortfolioId — (String)

      The unique identifier of the portfolio for which shares will be retrieved.

    • Type — (String)

      The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:

      1. ACCOUNT - Represents an external account to account share.

      2. ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.

      3. ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.

      4. ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.

      Possible values include:
      • "ACCOUNT"
      • "ORGANIZATION"
      • "ORGANIZATIONAL_UNIT"
      • "ORGANIZATION_MEMBER_ACCOUNT"
    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

      • PortfolioShareDetails — (Array<map>)

        Summaries about each of the portfolio shares.

        • PrincipalId — (String)

          The identifier of the recipient entity that received the portfolio share. The recipient entities can be one of the following:

          1. An external account.

          2. An organziation member account.

          3. An organzational unit (OU).

          4. The organization itself. (This shares with every account in the organization).

        • Type — (String)

          The type of the portfolio share.

          Possible values include:
          • "ACCOUNT"
          • "ORGANIZATION"
          • "ORGANIZATIONAL_UNIT"
          • "ORGANIZATION_MEMBER_ACCOUNT"
        • Accepted — (Boolean)

          Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.

        • ShareTagOptions — (Boolean)

          Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.

Returns:

  • (AWS.Request) —

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

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

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Service Reference:

Examples:

Calling the describePortfolioShareStatus operation

var params = {
  PortfolioShareToken: 'STRING_VALUE' /* required */
};
servicecatalog.describePortfolioShareStatus(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: {}) —
    • PortfolioShareToken — (String)

      The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

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:

      • PortfolioShareToken — (String)

        The token for the portfolio share operation. For example, share-6v24abcdefghi.

      • PortfolioId — (String)

        The portfolio identifier.

      • OrganizationNodeValue — (String)

        Organization node identifier. It can be either account id, organizational unit id or organization id.

      • Status — (String)

        Status of the portfolio share operation.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "COMPLETED_WITH_ERRORS"
        • "ERROR"
      • ShareDetails — (map)

        Information about the portfolio share operation.

        • SuccessfulShares — (Array<String>)

          List of accounts for whom the operation succeeded.

        • ShareErrors — (Array<map>)

          List of errors.

          • Accounts — (Array<String>)

            List of accounts impacted by the error.

          • Message — (String)

            Information about the error.

          • Error — (String)

            Error type that happened when processing the operation.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified product.

Service Reference:

Examples:

Calling the describeProduct operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
servicecatalog.describeProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The product identifier.

    • Name — (String)

      The product name.

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:

      • ProductViewSummary — (map)

        Summary information about the product view.

        • Id — (String)

          The product view identifier.

        • ProductId — (String)

          The product identifier.

        • Name — (String)

          The name of the product.

        • Owner — (String)

          The owner of the product. Contact the product administrator for the significance of this value.

        • ShortDescription — (String)

          Short description of the product.

        • Type — (String)

          The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE"
        • Distributor — (String)

          The distributor of the product. Contact the product administrator for the significance of this value.

        • HasDefaultPath — (Boolean)

          Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

        • SupportEmail — (String)

          The email contact information to obtain support for this Product.

        • SupportDescription — (String)

          The description of the support for this Product.

        • SupportUrl — (String)

          The URL information to obtain support for this Product.

      • ProvisioningArtifacts — (Array<map>)

        Information about the provisioning artifacts for the specified product.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • Budgets — (Array<map>)

        Information about the associated budgets.

        • BudgetName — (String)

          Name of the associated budget.

      • LaunchPaths — (Array<map>)

        Information about the associated launch paths.

        • Id — (String)

          The identifier of the launch path.

        • Name — (String)

          The name of the launch path.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified product. This operation is run with administrator access.

Service Reference:

Examples:

Calling the describeProductAsAdmin operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  SourcePortfolioId: 'STRING_VALUE'
};
servicecatalog.describeProductAsAdmin(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The product identifier.

    • Name — (String)

      The product name.

    • SourcePortfolioId — (String)

      The unique identifier of the shared portfolio that the specified product is associated with.

      You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.

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:

      • ProductViewDetail — (map)

        Information about the product view.

        • ProductViewSummary — (map)

          Summary information about the product view.

          • Id — (String)

            The product view identifier.

          • ProductId — (String)

            The product identifier.

          • Name — (String)

            The name of the product.

          • Owner — (String)

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription — (String)

            Short description of the product.

          • Type — (String)

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

            Possible values include:
            • "CLOUD_FORMATION_TEMPLATE"
            • "MARKETPLACE"
          • Distributor — (String)

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath — (Boolean)

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail — (String)

            The email contact information to obtain support for this Product.

          • SupportDescription — (String)

            The description of the support for this Product.

          • SupportUrl — (String)

            The URL information to obtain support for this Product.

        • Status — (String)

          The status of the product.

          • AVAILABLE - The product is ready for use.

          • CREATING - Product creation has started; the product is not ready for use.

          • FAILED - An action failed.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
        • ProductARN — (String)

          The ARN of the product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

      • ProvisioningArtifactSummaries — (Array<map>)

        Information about the provisioning artifacts (also known as versions) for the specified product.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProvisioningArtifactMetadata — (map<String>)

          The metadata for the provisioning artifact. This is used with AWS Marketplace products.

      • Tags — (Array<map>)

        Information about the tags associated with the product.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

      • TagOptions — (Array<map>)

        Information about the TagOptions associated with the product.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

      • Budgets — (Array<map>)

        Information about the associated budgets.

        • BudgetName — (String)

          Name of the associated budget.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified product.

Service Reference:

Examples:

Calling the describeProductView operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describeProductView(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The product view identifier.

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:

      • ProductViewSummary — (map)

        Summary information about the product.

        • Id — (String)

          The product view identifier.

        • ProductId — (String)

          The product identifier.

        • Name — (String)

          The name of the product.

        • Owner — (String)

          The owner of the product. Contact the product administrator for the significance of this value.

        • ShortDescription — (String)

          Short description of the product.

        • Type — (String)

          The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE"
        • Distributor — (String)

          The distributor of the product. Contact the product administrator for the significance of this value.

        • HasDefaultPath — (Boolean)

          Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

        • SupportEmail — (String)

          The email contact information to obtain support for this Product.

        • SupportDescription — (String)

          The description of the support for this Product.

        • SupportUrl — (String)

          The URL information to obtain support for this Product.

      • ProvisioningArtifacts — (Array<map>)

        Information about the provisioning artifacts for the product.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified provisioned product.

Service Reference:

Examples:

Calling the describeProvisionedProduct operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
servicecatalog.describeProvisionedProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The provisioned product identifier. You must provide the name or ID, but not both.

      If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

    • Name — (String)

      The name of the provisioned product. You must provide the name or ID, but not both.

      If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

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:

      • ProvisionedProductDetail — (map)

        Information about the provisioned product.

        • Name — (String)

          The user-friendly name of the provisioned product.

        • Arn — (String)

          The ARN of the provisioned product.

        • Type — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • Id — (String)

          The identifier of the provisioned product.

        • Status — (String)

          The current status of the provisioned product.

          • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

          • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

          • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

          • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

          • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

          Possible values include:
          • "AVAILABLE"
          • "UNDER_CHANGE"
          • "TAINTED"
          • "ERROR"
          • "PLAN_IN_PROGRESS"
        • StatusMessage — (String)

          The current status message of the provisioned product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • IdempotencyToken — (String)

          A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

        • LastRecordId — (String)

          The record identifier of the last request performed on this provisioned product.

        • LastProvisioningRecordId — (String)

          The record identifier of the last request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • LastSuccessfulProvisioningRecordId — (String)

          The record identifier of the last successful request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • ProductId — (String)

          The product identifier. For example, prod-abcdzk7xy33qa.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

      • CloudWatchDashboards — (Array<map>)

        Any CloudWatch dashboards that were created when provisioning the product.

        • Name — (String)

          The name of the CloudWatch dashboard.

Returns:

  • (AWS.Request) —

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

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

Gets information about the resource changes for the specified plan.

Service Reference:

Examples:

Calling the describeProvisionedProductPlan operation

var params = {
  PlanId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.describeProvisionedProductPlan(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PlanId — (String)

      The plan identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ProvisionedProductPlanDetails — (map)

        Information about the plan.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • PathId — (String)

          The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

        • ProductId — (String)

          The product identifier.

        • PlanName — (String)

          The name of the plan.

        • PlanId — (String)

          The plan identifier.

        • ProvisionProductId — (String)

          The product identifier.

        • ProvisionProductName — (String)

          The user-friendly name of the provisioned product.

        • PlanType — (String)

          The plan type.

          Possible values include:
          • "CLOUDFORMATION"
        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • Status — (String)

          The status.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_SUCCESS"
          • "CREATE_FAILED"
          • "EXECUTE_IN_PROGRESS"
          • "EXECUTE_SUCCESS"
          • "EXECUTE_FAILED"
        • UpdatedTime — (Date)

          The time when the plan was last updated.

        • NotificationArns — (Array<String>)

          Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

        • ProvisioningParameters — (Array<map>)

          Parameters specified by the administrator that are required for provisioning the product.

          • Key — (String)

            The parameter key.

          • Value — (String)

            The parameter value.

          • UsePreviousValue — (Boolean)

            If set to true, Value is ignored and the previous parameter value is kept.

        • Tags — (Array<map>)

          One or more tags.

          • Key — required — (String)

            The tag key.

          • Value — required — (String)

            The value for this key.

        • StatusMessage — (String)

          The status message.

      • ResourceChanges — (Array<map>)

        Information about the resource changes that will occur when the plan is executed.

        • Action — (String)

          The change action.

          Possible values include:
          • "ADD"
          • "MODIFY"
          • "REMOVE"
        • LogicalResourceId — (String)

          The ID of the resource, as defined in the CloudFormation template.

        • PhysicalResourceId — (String)

          The ID of the resource, if it was already created.

        • ResourceType — (String)

          The type of resource.

        • Replacement — (String)

          If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

          Possible values include:
          • "TRUE"
          • "FALSE"
          • "CONDITIONAL"
        • Scope — (Array<String>)

          The change scope.

        • Details — (Array<map>)

          Information about the resource changes.

          • Target — (map)

            Information about the resource attribute to be modified.

            • Attribute — (String)

              The attribute to be changed.

              Possible values include:
              • "PROPERTIES"
              • "METADATA"
              • "CREATIONPOLICY"
              • "UPDATEPOLICY"
              • "DELETIONPOLICY"
              • "TAGS"
            • Name — (String)

              If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

            • RequiresRecreation — (String)

              If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

              Possible values include:
              • "NEVER"
              • "CONDITIONALLY"
              • "ALWAYS"
          • Evaluation — (String)

            For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

            Possible values include:
            • "STATIC"
            • "DYNAMIC"
          • CausingEntity — (String)

            The ID of the entity that caused the change.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Service Reference:

Examples:

Calling the describeProvisioningArtifact operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE',
  Verbose: true || false
};
servicecatalog.describeProvisioningArtifact(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • ProductId — (String)

      The product identifier.

    • ProvisioningArtifactName — (String)

      The provisioning artifact name.

    • ProductName — (String)

      The product name.

    • Verbose — (Boolean)

      Indicates whether a verbose level of detail is enabled.

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:

      • ProvisioningArtifactDetail — (map)

        Information about the provisioning artifact.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • Type — (String)

          The type of provisioning artifact.

          • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

          • MARKETPLACE_AMI - AWS Marketplace AMI

          • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE_AMI"
          • "MARKETPLACE_CAR"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • Info — (map<String>)

        The URL of the CloudFormation template in Amazon S3.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Service Reference:

Examples:

Calling the describeProvisioningParameters operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  PathId: 'STRING_VALUE',
  PathName: 'STRING_VALUE',
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE'
};
servicecatalog.describeProvisioningParameters(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier. You must provide the product name or ID, but not both.

    • ProductName — (String)

      The name of the product. You must provide the name or ID, but not both.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    • ProvisioningArtifactName — (String)

      The name of the provisioning artifact. You must provide the name or ID, but not both.

    • PathId — (String)

      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    • PathName — (String)

      The name of the path. You must provide the name or ID, but not both.

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:

      • ProvisioningArtifactParameters — (Array<map>)

        Information about the parameters used to provision the product.

        • ParameterKey — (String)

          The parameter key.

        • DefaultValue — (String)

          The default value.

        • ParameterType — (String)

          The parameter type.

        • IsNoEcho — (Boolean)

          If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

        • Description — (String)

          The description of the parameter.

        • ParameterConstraints — (map)

          Constraints that the administrator has put on a parameter.

          • AllowedValues — (Array<String>)

            The values that the administrator has allowed for the parameter.

          • AllowedPattern — (String)

            A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

          • ConstraintDescription — (String)

            A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

            Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

            By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

            Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

          • MaxLength — (String)

            An integer value that determines the largest number of characters you want to allow for String types.

          • MinLength — (String)

            An integer value that determines the smallest number of characters you want to allow for String types.

          • MaxValue — (String)

            A numeric value that determines the largest numeric value you want to allow for Number types.

          • MinValue — (String)

            A numeric value that determines the smallest numeric value you want to allow for Number types.

      • ConstraintSummaries — (Array<map>)

        Information about the constraints used to provision the product.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

      • UsageInstructions — (Array<map>)

        Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

        • Type — (String)

          The usage instruction type for the value.

        • Value — (String)

          The usage instruction value for this type.

      • TagOptions — (Array<map>)

        Information about the TagOptions associated with the resource.

        • Key — (String)

          The TagOption key.

        • Values — (Array<String>)

          The TagOption value.

      • ProvisioningArtifactPreferences — (map)

        An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.

        • StackSetAccounts — (Array<String>)

          One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

          Applicable only to a CFN_STACKSET provisioned product type.

        • StackSetRegions — (Array<String>)

          One or more AWS Regions where stack instances are deployed from the stack set. These regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

          Applicable only to a CFN_STACKSET provisioned product type.

      • ProvisioningArtifactOutputs — (Array<map>)

        The output of the provisioning artifact.

        • Key — (String)

          The provisioning artifact output key.

        • Description — (String)

          Description of the provisioning artifact output key.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Note: If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Service Reference:

Examples:

Calling the describeRecord operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.describeRecord(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The record identifier of the provisioned product. This identifier is returned by the request operation.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • RecordDetail — (map)

        Information about the product.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

      • RecordOutputs — (Array<map>)

        Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

        • OutputKey — (String)

          The output key.

        • OutputValue — (String)

          The output value.

        • Description — (String)

          The description of the output.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Describes a self-service action.

Service Reference:

Examples:

Calling the describeServiceAction operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describeServiceAction(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: {}) —
    • Id — (String)

      The self-service action identifier.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • ServiceActionDetail — (map)

        Detailed information about the self-service action.

        • ServiceActionSummary — (map)

          Summary information about the self-service action.

          • Id — (String)

            The self-service action identifier.

          • Name — (String)

            The self-service action name.

          • Description — (String)

            The self-service action description.

          • DefinitionType — (String)

            The self-service action definition type. For example, SSM_AUTOMATION.

            Possible values include:
            • "SSM_AUTOMATION"
        • Definition — (map<String>)

          A map that defines the self-service action.

Returns:

  • (AWS.Request) —

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

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

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

Service Reference:

Examples:

Calling the describeServiceActionExecutionParameters operation

var params = {
  ProvisionedProductId: 'STRING_VALUE', /* required */
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.describeServiceActionExecutionParameters(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: {}) —
    • ProvisionedProductId — (String)

      The identifier of the provisioned product.

    • ServiceActionId — (String)

      The self-service action identifier.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • ServiceActionParameters — (Array<map>)

        The parameters of the self-service action.

        • Name — (String)

          The name of the execution parameter.

        • Type — (String)

          The execution parameter type.

        • DefaultValues — (Array<String>)

          The default values for the execution parameter.

Returns:

  • (AWS.Request) —

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

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

Gets information about the specified TagOption.

Service Reference:

Examples:

Calling the describeTagOption operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
servicecatalog.describeTagOption(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: {}) —
    • Id — (String)

      The TagOption identifier.

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:

      • TagOptionDetail — (map)

        Information about the TagOption.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

Returns:

  • (AWS.Request) —

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

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

Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the management account in the organization.

This API can't be invoked if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

Service Reference:

Examples:

Calling the disableAWSOrganizationsAccess operation

var params = {
};
servicecatalog.disableAWSOrganizationsAccess(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: {})

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.

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

Disassociates the specified budget from the specified resource.

Service Reference:

Examples:

Calling the disassociateBudgetFromResource operation

var params = {
  BudgetName: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
servicecatalog.disassociateBudgetFromResource(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: {}) —
    • BudgetName — (String)

      The name of the budget you want to disassociate.

    • ResourceId — (String)

      The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

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.

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

Disassociates a previously associated principal ARN from a specified portfolio.

Service Reference:

Examples:

Calling the disassociatePrincipalFromPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  PrincipalARN: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.disassociatePrincipalFromPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • PrincipalARN — (String)

      The ARN of the principal (IAM user, role, or group).

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.

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

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

Service Reference:

Examples:

Calling the disassociateProductFromPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.disassociateProductFromPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • PortfolioId — (String)

      The portfolio identifier.

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.

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

Disassociates the specified self-service action association from the specified provisioning artifact.

Service Reference:

Examples:

Calling the disassociateServiceActionFromProvisioningArtifact operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.disassociateServiceActionFromProvisioningArtifact(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: {}) —
    • ProductId — (String)

      The product identifier. For example, prod-abcdzk7xy33qa.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    • ServiceActionId — (String)

      The self-service action identifier. For example, act-fs7abcd89wxyz.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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.

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

Disassociates the specified TagOption from the specified resource.

Service Reference:

Examples:

Calling the disassociateTagOptionFromResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagOptionId: 'STRING_VALUE' /* required */
};
servicecatalog.disassociateTagOptionFromResource(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: {}) —
    • ResourceId — (String)

      The resource identifier.

    • TagOptionId — (String)

      The TagOption identifier.

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.

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

Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

Service Reference:

Examples:

Calling the enableAWSOrganizationsAccess operation

var params = {
};
servicecatalog.enableAWSOrganizationsAccess(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: {})

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.

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

Provisions or modifies a product based on the resource changes for the specified plan.

Service Reference:

Examples:

Calling the executeProvisionedProductPlan operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  PlanId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.executeProvisionedProductPlan(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PlanId — (String)

      The plan identifier.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • RecordDetail — (map)

        Information about the result of provisioning the product.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Executes a self-service action against a provisioned product.

Service Reference:

Examples:

Calling the executeProvisionedProductServiceAction operation

var params = {
  ExecuteToken: 'STRING_VALUE', /* required */
  ProvisionedProductId: 'STRING_VALUE', /* required */
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Parameters: {
    '<ExecutionParameterKey>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ExecutionParameterKey>': ... */
  }
};
servicecatalog.executeProvisionedProductServiceAction(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: {}) —
    • ProvisionedProductId — (String)

      The identifier of the provisioned product.

    • ServiceActionId — (String)

      The self-service action identifier. For example, act-fs7abcd89wxyz.

    • ExecuteToken — (String)

      An idempotency token that uniquely identifies the execute request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Parameters — (map<Array<String>>)

      A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET, the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET.

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:

      • RecordDetail — (map)

        An object containing detailed information about the result of provisioning the product.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

Service Reference:

Examples:

Calling the getAWSOrganizationsAccessStatus operation

var params = {
};
servicecatalog.getAWSOrganizationsAccessStatus(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: {})

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:

      • AccessStatus — (String)

        The status of the portfolio share feature.

        Possible values include:
        • "ENABLED"
        • "UNDER_CHANGE"
        • "DISABLED"

Returns:

  • (AWS.Request) —

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

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

This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

Service Reference:

Examples:

Calling the getProvisionedProductOutputs operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  OutputKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  ProvisionedProductId: 'STRING_VALUE',
  ProvisionedProductName: 'STRING_VALUE'
};
servicecatalog.getProvisionedProductOutputs(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisionedProductId — (String)

      The identifier of the provisioned product that you want the outputs from.

    • ProvisionedProductName — (String)

      The name of the provisioned product that you want the outputs from.

    • OutputKeys — (Array<String>)

      The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • Outputs — (Array<map>)

        Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

        • OutputKey — (String)

          The output key.

        • OutputValue — (String)

          The output value.

        • Description — (String)

          The description of the output.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Requests the import of a resource as a Service Catalog provisioned product that is associated to a Service Catalog product and provisioning artifact. Once imported, all supported Service Catalog governance actions are supported on the provisioned product.

Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets and non-root nested stacks are not supported.

The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, IMPORT_ROLLBACK_COMPLETE.

Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.

The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.

Service Reference:

Examples:

Calling the importAsProvisionedProduct operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  PhysicalId: 'STRING_VALUE', /* required */
  ProductId: 'STRING_VALUE', /* required */
  ProvisionedProductName: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.importAsProvisionedProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • ProvisionedProductName — (String)

      The user-friendly name of the provisioned product. The value must be unique for the AWS account. The name cannot be updated after the product is provisioned.

    • PhysicalId — (String)

      The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.

    • IdempotencyToken — (String)

      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

      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:

      • RecordDetail — (map)

        Information about a request operation.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Lists all portfolios for which sharing was accepted by this account.

Service Reference:

Examples:

Calling the listAcceptedPortfolioShares operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  PortfolioShareType: IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS
};
servicecatalog.listAcceptedPortfolioShares(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PortfolioShareType — (String)

      The type of shared portfolios to list. The default is to list imported portfolios.

      • AWS_ORGANIZATIONS - List portfolios shared by the management account of your organization

      • AWS_SERVICECATALOG - List default portfolios

      • IMPORTED - List imported portfolios

      Possible values include:
      • "IMPORTED"
      • "AWS_SERVICECATALOG"
      • "AWS_ORGANIZATIONS"

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:

      • PortfolioDetails — (Array<map>)

        Information about the portfolios.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all the budgets associated to the specified resource.

Service Reference:

Examples:

Calling the listBudgetsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listBudgetsForResource(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ResourceId — (String)

      The resource identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • Budgets — (Array<map>)

        Information about the associated budgets.

        • BudgetName — (String)

          Name of the associated budget.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the constraints for the specified portfolio and product.

Service Reference:

Examples:

Calling the listConstraintsForPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  ProductId: 'STRING_VALUE'
};
servicecatalog.listConstraintsForPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • ProductId — (String)

      The product identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ConstraintDetails — (Array<map>)

        Information about the constraints.

        • ConstraintId — (String)

          The identifier of the constraint.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

        • ProductId — (String)

          The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

        • PortfolioId — (String)

          The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Service Reference:

Examples:

Calling the listLaunchPaths operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listLaunchPaths(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • LaunchPathSummaries — (Array<map>)

        Information about the launch path.

        • Id — (String)

          The identifier of the product path.

        • ConstraintSummaries — (Array<map>)

          The constraints on the portfolio-product relationship.

          • Type — (String)

            The type of constraint.

            • LAUNCH

            • NOTIFICATION

            • STACKSET

            • TEMPLATE

          • Description — (String)

            The description of the constraint.

        • Tags — (Array<map>)

          The tags associated with this product path.

          • Key — required — (String)

            The tag key.

          • Value — required — (String)

            The value for this key.

        • Name — (String)

          The name of the portfolio to which the user was assigned.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

If a delegated admin is de-registered, they can no longer perform this operation.

Service Reference:

Examples:

Calling the listOrganizationPortfolioAccess operation

var params = {
  OrganizationNodeType: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT, /* required */
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listOrganizationPortfolioAccess(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier. For example, port-2abcdext3y5fk.

    • OrganizationNodeType — (String)

      The organization node type that will be returned in the output.

      • ORGANIZATION - Organization that has access to the portfolio.

      • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.

      • ACCOUNT - Account that has access to the portfolio within your organization.

      Possible values include:
      • "ORGANIZATION"
      • "ORGANIZATIONAL_UNIT"
      • "ACCOUNT"
    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • OrganizationNodes — (Array<map>)

        Displays information about the organization nodes.

        • Type — (String)

          The organization node type.

          Possible values include:
          • "ORGANIZATION"
          • "ORGANIZATIONAL_UNIT"
          • "ACCOUNT"
        • Value — (String)

          The identifier of the organization node.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the account IDs that have access to the specified portfolio.

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

Service Reference:

Examples:

Calling the listPortfolioAccess operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  OrganizationParentId: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listPortfolioAccess(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • OrganizationParentId — (String)

      The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • AccountIds — (Array<String>)

        Information about the AWS accounts with access to the portfolio.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all portfolios in the catalog.

Service Reference:

Examples:

Calling the listPortfolios operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listPortfolios(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • PortfolioDetails — (Array<map>)

        Information about the portfolios.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all portfolios that the specified product is associated with.

Service Reference:

Examples:

Calling the listPortfoliosForProduct operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listPortfoliosForProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • PortfolioDetails — (Array<map>)

        Information about the portfolios.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all principal ARNs associated with the specified portfolio.

Service Reference:

Examples:

Calling the listPrincipalsForPortfolio operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listPrincipalsForPortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • Principals — (Array<map>)

        The IAM principals (users or roles) associated with the portfolio.

        • PrincipalARN — (String)

          The ARN of the principal (IAM user, role, or group).

        • PrincipalType — (String)

          The principal type. The supported value is IAM.

          Possible values include:
          • "IAM"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the plans for the specified provisioned product or all plans to which the user has access.

Service Reference:

Examples:

Calling the listProvisionedProductPlans operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  AccessLevelFilter: {
    Key: Account | Role | User,
    Value: 'STRING_VALUE'
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  ProvisionProductId: 'STRING_VALUE'
};
servicecatalog.listProvisionedProductPlans(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisionProductId — (String)

      The product identifier.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • AccessLevelFilter — (map)

      The access level to use to obtain results. The default is User.

      • Key — (String)

        The access level.

        • Account - Filter results based on the account.

        • Role - Filter results based on the federated role of the specified user.

        • User - Filter results based on the specified user.

        Possible values include:
        • "Account"
        • "Role"
        • "User"
      • Value — (String)

        The user to which the access level applies. The only supported value is Self.

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:

      • ProvisionedProductPlans — (Array<map>)

        Information about the plans.

        • PlanName — (String)

          The name of the plan.

        • PlanId — (String)

          The plan identifier.

        • ProvisionProductId — (String)

          The product identifier.

        • ProvisionProductName — (String)

          The user-friendly name of the provisioned product.

        • PlanType — (String)

          The plan type.

          Possible values include:
          • "CLOUDFORMATION"
        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all provisioning artifacts (also known as versions) for the specified product.

Service Reference:

Examples:

Calling the listProvisioningArtifacts operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.listProvisioningArtifacts(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

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:

      • ProvisioningArtifactDetails — (Array<map>)

        Information about the provisioning artifacts.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • Type — (String)

          The type of provisioning artifact.

          • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

          • MARKETPLACE_AMI - AWS Marketplace AMI

          • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE_AMI"
          • "MARKETPLACE_CAR"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

Service Reference:

Examples:

Calling the listProvisioningArtifactsForServiceAction operation

var params = {
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listProvisioningArtifactsForServiceAction(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: {}) —
    • ServiceActionId — (String)

      The self-service action identifier. For example, act-fs7abcd89wxyz.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • ProvisioningArtifactViews — (Array<map>)

        An array of objects with information about product views and provisioning artifacts.

        • ProductViewSummary — (map)

          Summary information about a product view.

          • Id — (String)

            The product view identifier.

          • ProductId — (String)

            The product identifier.

          • Name — (String)

            The name of the product.

          • Owner — (String)

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription — (String)

            Short description of the product.

          • Type — (String)

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

            Possible values include:
            • "CLOUD_FORMATION_TEMPLATE"
            • "MARKETPLACE"
          • Distributor — (String)

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath — (Boolean)

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail — (String)

            The email contact information to obtain support for this Product.

          • SupportDescription — (String)

            The description of the support for this Product.

          • SupportUrl — (String)

            The URL information to obtain support for this Product.

        • ProvisioningArtifact — (map)

          Information about a provisioning artifact. A provisioning artifact is also known as a product version.

          • Id — (String)

            The identifier of the provisioning artifact.

          • Name — (String)

            The name of the provisioning artifact.

          • Description — (String)

            The description of the provisioning artifact.

          • CreatedTime — (Date)

            The UTC time stamp of the creation time.

          • Guidance — (String)

            Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

            Possible values include:
            • "DEFAULT"
            • "DEPRECATED"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the specified requests or all performed requests.

Service Reference:

Examples:

Calling the listRecordHistory operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  AccessLevelFilter: {
    Key: Account | Role | User,
    Value: 'STRING_VALUE'
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  SearchFilter: {
    Key: 'STRING_VALUE',
    Value: 'STRING_VALUE'
  }
};
servicecatalog.listRecordHistory(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • AccessLevelFilter — (map)

      The access level to use to obtain results. The default is User.

      • Key — (String)

        The access level.

        • Account - Filter results based on the account.

        • Role - Filter results based on the federated role of the specified user.

        • User - Filter results based on the specified user.

        Possible values include:
        • "Account"
        • "Role"
        • "User"
      • Value — (String)

        The user to which the access level applies. The only supported value is Self.

    • SearchFilter — (map)

      The search filter to scope the results.

      • Key — (String)

        The filter key.

        • product - Filter results based on the specified product identifier.

        • provisionedproduct - Filter results based on the provisioned product identifier.

      • Value — (String)

        The filter value.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • RecordDetails — (Array<map>)

        The records, in reverse chronological order.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the resources associated with the specified TagOption.

Service Reference:

Examples:

Calling the listResourcesForTagOption operation

var params = {
  TagOptionId: 'STRING_VALUE', /* required */
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
servicecatalog.listResourcesForTagOption(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: {}) —
    • TagOptionId — (String)

      The TagOption identifier.

    • ResourceType — (String)

      The resource type.

      • Portfolio

      • Product

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ResourceDetails — (Array<map>)

        Information about the resources.

        • Id — (String)

          The identifier of the resource.

        • ARN — (String)

          The ARN of the resource.

        • Name — (String)

          The name of the resource.

        • Description — (String)

          The description of the resource.

        • CreatedTime — (Date)

          The creation time of the resource.

      • PageToken — (String)

        The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

  • (AWS.Request) —

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

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

Lists all self-service actions.

Service Reference:

Examples:

Calling the listServiceActions operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listServiceActions(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ServiceActionSummaries — (Array<map>)

        An object containing information about the service actions associated with the provisioning artifact.

        • Id — (String)

          The self-service action identifier.

        • Name — (String)

          The self-service action name.

        • Description — (String)

          The self-service action description.

        • DefinitionType — (String)

          The self-service action definition type. For example, SSM_AUTOMATION.

          Possible values include:
          • "SSM_AUTOMATION"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

Service Reference:

Examples:

Calling the listServiceActionsForProvisioningArtifact operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listServiceActionsForProvisioningArtifact(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: {}) —
    • ProductId — (String)

      The product identifier. For example, prod-abcdzk7xy33qa.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • ServiceActionSummaries — (Array<map>)

        An object containing information about the self-service actions associated with the provisioning artifact.

        • Id — (String)

          The self-service action identifier.

        • Name — (String)

          The self-service action name.

        • Description — (String)

          The self-service action description.

        • DefinitionType — (String)

          The self-service action definition type. For example, SSM_AUTOMATION.

          Possible values include:
          • "SSM_AUTOMATION"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific AWS account name or region.

Service Reference:

Examples:

Calling the listStackInstancesForProvisionedProduct operation

var params = {
  ProvisionedProductId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listStackInstancesForProvisionedProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisionedProductId — (String)

      The identifier of the provisioned product.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

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:

      • StackInstances — (Array<map>)

        List of stack instances.

        • Account — (String)

          The name of the AWS account that the stack instance is associated with.

        • Region — (String)

          The name of the AWS region that the stack instance is associated with.

        • StackInstanceStatus — (String)

          The status of the stack instance, in terms of its synchronization with its associated stack set.

          • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

          • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

          • CURRENT: The stack is currently up to date with the stack set.

          Possible values include:
          • "CURRENT"
          • "OUTDATED"
          • "INOPERABLE"
      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Lists the specified TagOptions or all TagOptions.

Service Reference:

Examples:

Calling the listTagOptions operation

var params = {
  Filters: {
    Active: true || false,
    Key: 'STRING_VALUE',
    Value: 'STRING_VALUE'
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.listTagOptions(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: {}) —
    • Filters — (map)

      The search filters. If no search filters are specified, the output includes all TagOptions.

      • Key — (String)

        The TagOption key.

      • Value — (String)

        The TagOption value.

      • Active — (Boolean)

        The active state.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • TagOptionDetails — (Array<map>)

        Information about the TagOptions.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

      • PageToken — (String)

        The page token for the next set of results. To retrieve the first set of results, use null.

Returns:

  • (AWS.Request) —

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

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

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Service Reference:

Examples:

Calling the provisionProduct operation

var params = {
  ProvisionToken: 'STRING_VALUE', /* required */
  ProvisionedProductName: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  NotificationArns: [
    'STRING_VALUE',
    /* more items */
  ],
  PathId: 'STRING_VALUE',
  PathName: 'STRING_VALUE',
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE',
  ProvisioningParameters: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  ProvisioningPreferences: {
    StackSetAccounts: [
      'STRING_VALUE',
      /* more items */
    ],
    StackSetFailureToleranceCount: 'NUMBER_VALUE',
    StackSetFailureTolerancePercentage: 'NUMBER_VALUE',
    StackSetMaxConcurrencyCount: 'NUMBER_VALUE',
    StackSetMaxConcurrencyPercentage: 'NUMBER_VALUE',
    StackSetRegions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.provisionProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier. You must provide the name or ID, but not both.

    • ProductName — (String)

      The name of the product. You must provide the name or ID, but not both.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact. You must provide the name or ID, but not both.

    • ProvisioningArtifactName — (String)

      The name of the provisioning artifact. You must provide the name or ID, but not both.

    • PathId — (String)

      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.

    • PathName — (String)

      The name of the path. You must provide the name or ID, but not both.

    • ProvisionedProductName — (String)

      A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

    • ProvisioningParameters — (Array<map>)

      Parameters specified by the administrator that are required for provisioning the product.

      • Key — (String)

        The parameter key.

      • Value — (String)

        The parameter value.

    • ProvisioningPreferences — (map)

      An object that contains information about the provisioning preferences for a stack set.

      • StackSetAccounts — (Array<String>)

        One or more AWS accounts where the provisioned product will be available.

        Applicable only to a CFN_STACKSET provisioned product type.

        The specified accounts should be within the list of accounts from the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

        If no values are specified, the default value is all acounts from the STACKSET constraint.

      • StackSetRegions — (Array<String>)

        One or more AWS Regions where the provisioned product will be available.

        Applicable only to a CFN_STACKSET provisioned product type.

        The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

        If no values are specified, the default value is all regions from the STACKSET constraint.

      • StackSetFailureToleranceCount — (Integer)

        The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

        The default value is 0 if no value is specified.

      • StackSetFailureTolerancePercentage — (Integer)

        The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

        When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

      • StackSetMaxConcurrencyCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

      • StackSetMaxConcurrencyPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    • Tags — (Array<map>)

      One or more tags.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • NotificationArns — (Array<String>)

      Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    • ProvisionToken — (String)

      An idempotency token that uniquely identifies the provisioning request.

      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:

      • RecordDetail — (map)

        Information about the result of provisioning the product.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Rejects an offer to share the specified portfolio.

Service Reference:

Examples:

Calling the rejectPortfolioShare operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PortfolioShareType: IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS
};
servicecatalog.rejectPortfolioShare(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • PortfolioShareType — (String)

      The type of shared portfolios to reject. The default is to reject imported portfolios.

      • AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your organization.

      • IMPORTED - Reject imported portfolios.

      • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

      For example, aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS

      Possible values include:
      • "IMPORTED"
      • "AWS_SERVICECATALOG"
      • "AWS_ORGANIZATIONS"

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.

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

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

Service Reference:

Examples:

Calling the scanProvisionedProducts operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  AccessLevelFilter: {
    Key: Account | Role | User,
    Value: 'STRING_VALUE'
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.scanProvisionedProducts(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • AccessLevelFilter — (map)

      The access level to use to obtain results. The default is User.

      • Key — (String)

        The access level.

        • Account - Filter results based on the account.

        • Role - Filter results based on the federated role of the specified user.

        • User - Filter results based on the specified user.

        Possible values include:
        • "Account"
        • "Role"
        • "User"
      • Value — (String)

        The user to which the access level applies. The only supported value is Self.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ProvisionedProducts — (Array<map>)

        Information about the provisioned products.

        • Name — (String)

          The user-friendly name of the provisioned product.

        • Arn — (String)

          The ARN of the provisioned product.

        • Type — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • Id — (String)

          The identifier of the provisioned product.

        • Status — (String)

          The current status of the provisioned product.

          • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

          • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

          • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

          • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

          • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

          Possible values include:
          • "AVAILABLE"
          • "UNDER_CHANGE"
          • "TAINTED"
          • "ERROR"
          • "PLAN_IN_PROGRESS"
        • StatusMessage — (String)

          The current status message of the provisioned product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • IdempotencyToken — (String)

          A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

        • LastRecordId — (String)

          The record identifier of the last request performed on this provisioned product.

        • LastProvisioningRecordId — (String)

          The record identifier of the last request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • LastSuccessfulProvisioningRecordId — (String)

          The record identifier of the last successful request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • ProductId — (String)

          The product identifier. For example, prod-abcdzk7xy33qa.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Gets information about the products to which the caller has access.

Service Reference:

Examples:

Calling the searchProducts operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Filters: {
    '<ProductViewFilterBy>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ProductViewFilterBy>': ... */
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  SortBy: Title | VersionCount | CreationDate,
  SortOrder: ASCENDING | DESCENDING
};
servicecatalog.searchProducts(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Filters — (map<Array<String>>)

      The search filters. If no search filters are specified, the output includes all products to which the caller has access.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • SortBy — (String)

      The sort field. If no value is specified, the results are not sorted.

      Possible values include:
      • "Title"
      • "VersionCount"
      • "CreationDate"
    • SortOrder — (String)

      The sort order. If no value is specified, the results are not sorted.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ProductViewSummaries — (Array<map>)

        Information about the product views.

        • Id — (String)

          The product view identifier.

        • ProductId — (String)

          The product identifier.

        • Name — (String)

          The name of the product.

        • Owner — (String)

          The owner of the product. Contact the product administrator for the significance of this value.

        • ShortDescription — (String)

          Short description of the product.

        • Type — (String)

          The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE"
        • Distributor — (String)

          The distributor of the product. Contact the product administrator for the significance of this value.

        • HasDefaultPath — (Boolean)

          Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

        • SupportEmail — (String)

          The email contact information to obtain support for this Product.

        • SupportDescription — (String)

          The description of the support for this Product.

        • SupportUrl — (String)

          The URL information to obtain support for this Product.

      • ProductViewAggregations — (map<Array<map>>)

        The product view aggregations.

        • Value — (String)

          The value of the product view aggregation.

        • ApproximateCount — (Integer)

          An approximate count of the products that match the value.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Gets information about the products for the specified portfolio or all products.

Service Reference:

Examples:

Calling the searchProductsAsAdmin operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Filters: {
    '<ProductViewFilterBy>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ProductViewFilterBy>': ... */
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  PortfolioId: 'STRING_VALUE',
  ProductSource: ACCOUNT,
  SortBy: Title | VersionCount | CreationDate,
  SortOrder: ASCENDING | DESCENDING
};
servicecatalog.searchProductsAsAdmin(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The portfolio identifier.

    • Filters — (map<Array<String>>)

      The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

    • SortBy — (String)

      The sort field. If no value is specified, the results are not sorted.

      Possible values include:
      • "Title"
      • "VersionCount"
      • "CreationDate"
    • SortOrder — (String)

      The sort order. If no value is specified, the results are not sorted.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • ProductSource — (String)

      Access level of the source of the product.

      Possible values include:
      • "ACCOUNT"

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:

      • ProductViewDetails — (Array<map>)

        Information about the product views.

        • ProductViewSummary — (map)

          Summary information about the product view.

          • Id — (String)

            The product view identifier.

          • ProductId — (String)

            The product identifier.

          • Name — (String)

            The name of the product.

          • Owner — (String)

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription — (String)

            Short description of the product.

          • Type — (String)

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

            Possible values include:
            • "CLOUD_FORMATION_TEMPLATE"
            • "MARKETPLACE"
          • Distributor — (String)

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath — (Boolean)

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail — (String)

            The email contact information to obtain support for this Product.

          • SupportDescription — (String)

            The description of the support for this Product.

          • SupportUrl — (String)

            The URL information to obtain support for this Product.

        • Status — (String)

          The status of the product.

          • AVAILABLE - The product is ready for use.

          • CREATING - Product creation has started; the product is not ready for use.

          • FAILED - An action failed.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
        • ProductARN — (String)

          The ARN of the product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Gets information about the provisioned products that meet the specified criteria.

Service Reference:

Examples:

Calling the searchProvisionedProducts operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  AccessLevelFilter: {
    Key: Account | Role | User,
    Value: 'STRING_VALUE'
  },
  Filters: {
    '<ProvisionedProductViewFilterBy>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<ProvisionedProductViewFilterBy>': ... */
  },
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE',
  SortBy: 'STRING_VALUE',
  SortOrder: ASCENDING | DESCENDING
};
servicecatalog.searchProvisionedProducts(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • AccessLevelFilter — (map)

      The access level to use to obtain results. The default is User.

      • Key — (String)

        The access level.

        • Account - Filter results based on the account.

        • Role - Filter results based on the federated role of the specified user.

        • User - Filter results based on the specified user.

        Possible values include:
        • "Account"
        • "Role"
        • "User"
      • Value — (String)

        The user to which the access level applies. The only supported value is Self.

    • Filters — (map<Array<String>>)

      The search filters.

      When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, userArnSession, lastProvisioningRecordId, lastSuccessfulProvisioningRecordId, productName, and provisioningArtifactName.

      Example: "SearchQuery":["status:AVAILABLE"]

    • SortBy — (String)

      The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

    • SortOrder — (String)

      The sort order. If no value is specified, the results are not sorted.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • PageSize — (Integer)

      The maximum number of items to return with this call.

    • PageToken — (String)

      The page token for the next set of results. To retrieve the first set of results, use null.

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:

      • ProvisionedProducts — (Array<map>)

        Information about the provisioned products.

        • Name — (String)

          The user-friendly name of the provisioned product.

        • Arn — (String)

          The ARN of the provisioned product.

        • Type — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • Id — (String)

          The identifier of the provisioned product.

        • Status — (String)

          The current status of the provisioned product.

          • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

          • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

          • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

          • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

          • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

          Possible values include:
          • "AVAILABLE"
          • "UNDER_CHANGE"
          • "TAINTED"
          • "ERROR"
          • "PLAN_IN_PROGRESS"
        • StatusMessage — (String)

          The current status message of the provisioned product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • IdempotencyToken — (String)

          A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

        • LastRecordId — (String)

          The record identifier of the last request performed on this provisioned product.

        • LastProvisioningRecordId — (String)

          The record identifier of the last request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • LastSuccessfulProvisioningRecordId — (String)

          The record identifier of the last successful request performed on this provisioned product of the following types:

          • ProvisionedProduct

          • UpdateProvisionedProduct

          • ExecuteProvisionedProductPlan

          • TerminateProvisionedProduct

        • Tags — (Array<map>)

          One or more tags.

          • Key — required — (String)

            The tag key.

          • Value — required — (String)

            The value for this key.

        • PhysicalId — (String)

          The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

        • ProductId — (String)

          The product identifier.

        • ProductName — (String)

          The name of the product.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • ProvisioningArtifactName — (String)

          The name of the provisioning artifact.

        • UserArn — (String)

          The Amazon Resource Name (ARN) of the IAM user.

        • UserArnSession — (String)

          The ARN of the IAM user in the session. This ARN might contain a session ID.

      • TotalResultsCount — (Integer)

        The number of provisioned products found.

      • NextPageToken — (String)

        The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Returns:

  • (AWS.Request) —

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

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

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

Service Reference:

Examples:

Calling the terminateProvisionedProduct operation

var params = {
  TerminateToken: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  IgnoreErrors: true || false,
  ProvisionedProductId: 'STRING_VALUE',
  ProvisionedProductName: 'STRING_VALUE',
  RetainPhysicalResources: true || false
};
servicecatalog.terminateProvisionedProduct(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: {}) —
    • ProvisionedProductName — (String)

      The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    • ProvisionedProductId — (String)

      The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    • TerminateToken — (String)

      An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

      If a token is not provided, the SDK will use a version 4 UUID.
    • IgnoreErrors — (Boolean)

      If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • RetainPhysicalResources — (Boolean)

      When this boolean parameter is set to true, the TerminateProvisionedProduct API deletes the Service Catalog provisioned product. However, it does not remove the CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.

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:

      • RecordDetail — (map)

        Information about the result of this request.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Updates the specified constraint.

Service Reference:

Examples:

Calling the updateConstraint operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Parameters: 'STRING_VALUE'
};
servicecatalog.updateConstraint(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The identifier of the constraint.

    • Description — (String)

      The updated description of the constraint.

    • Parameters — (String)

      The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

      LAUNCH

      You are required to specify either the RoleArn or the LocalRoleName but can't use both.

      Specify the RoleArn property as follows:

      {"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}

      Specify the LocalRoleName property as follows:

      {"LocalRoleName": "SCBasicLaunchRole"}

      If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

      Note: The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one LAUNCH constraint on a product and portfolio.

      NOTIFICATION

      Specify the NotificationArns property as follows:

      {"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}

      RESOURCE_UPDATE

      Specify the TagUpdatesOnProvisionedProduct property as follows:

      {"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}

      The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

      STACKSET

      Specify the Parameters property as follows:

      {"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}

      You cannot have both a LAUNCH and a STACKSET constraint.

      You also cannot have more than one STACKSET constraint on a product and portfolio.

      Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

      TEMPLATE

      Specify the Rules property. For more information, see Template Constraint Rules.

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:

      • ConstraintDetail — (map)

        Information about the constraint.

        • ConstraintId — (String)

          The identifier of the constraint.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

          • STACKSET

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

        • ProductId — (String)

          The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.

        • PortfolioId — (String)

          The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.

      • ConstraintParameters — (String)

        The constraint parameters.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Updates the specified portfolio.

You cannot update a product that was shared with you.

Service Reference:

Examples:

Calling the updatePortfolio operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AddTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  ProviderName: 'STRING_VALUE',
  RemoveTags: [
    'STRING_VALUE',
    /* more items */
  ]
};
servicecatalog.updatePortfolio(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The portfolio identifier.

    • DisplayName — (String)

      The name to use for display purposes.

    • Description — (String)

      The updated description of the portfolio.

    • ProviderName — (String)

      The updated name of the portfolio provider.

    • AddTags — (Array<map>)

      The tags to add.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • RemoveTags — (Array<String>)

      The tags to remove.

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:

      • PortfolioDetail — (map)

        Information about the portfolio.

        • Id — (String)

          The portfolio identifier.

        • ARN — (String)

          The ARN assigned to the portfolio.

        • DisplayName — (String)

          The name to use for display purposes.

        • Description — (String)

          The description of the portfolio.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

Returns:

  • (AWS.Request) —

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

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

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing for an existing portfolio share.

The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.

You must provide the accountId or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.

This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.

Service Reference:

Examples:

Calling the updatePortfolioShare operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AccountId: 'STRING_VALUE',
  OrganizationNode: {
    Type: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT,
    Value: 'STRING_VALUE'
  },
  ShareTagOptions: true || false
};
servicecatalog.updatePortfolioShare(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • PortfolioId — (String)

      The unique identifier of the portfolio for which the share will be updated.

    • AccountId — (String)

      The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.

    • OrganizationNode — (map)

      Information about the organization node.

      • Type — (String)

        The organization node type.

        Possible values include:
        • "ORGANIZATION"
        • "ORGANIZATIONAL_UNIT"
        • "ACCOUNT"
      • Value — (String)

        The identifier of the organization node.

    • ShareTagOptions — (Boolean)

      A flag to enable or disable TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

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:

      • PortfolioShareToken — (String)

        The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.

      • Status — (String)

        The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "COMPLETED_WITH_ERRORS"
        • "ERROR"

Returns:

  • (AWS.Request) —

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

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

Updates the specified product.

Service Reference:

Examples:

Calling the updateProduct operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AddTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Distributor: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Owner: 'STRING_VALUE',
  RemoveTags: [
    'STRING_VALUE',
    /* more items */
  ],
  SupportDescription: 'STRING_VALUE',
  SupportEmail: 'STRING_VALUE',
  SupportUrl: 'STRING_VALUE'
};
servicecatalog.updateProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • Id — (String)

      The product identifier.

    • Name — (String)

      The updated product name.

    • Owner — (String)

      The updated owner of the product.

    • Description — (String)

      The updated description of the product.

    • Distributor — (String)

      The updated distributor of the product.

    • SupportDescription — (String)

      The updated support description for the product.

    • SupportEmail — (String)

      The updated support email for the product.

    • SupportUrl — (String)

      The updated support URL for the product.

    • AddTags — (Array<map>)

      The tags to add to the product.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • RemoveTags — (Array<String>)

      The tags to remove from the product.

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:

      • ProductViewDetail — (map)

        Information about the product view.

        • ProductViewSummary — (map)

          Summary information about the product view.

          • Id — (String)

            The product view identifier.

          • ProductId — (String)

            The product identifier.

          • Name — (String)

            The name of the product.

          • Owner — (String)

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription — (String)

            Short description of the product.

          • Type — (String)

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

            Possible values include:
            • "CLOUD_FORMATION_TEMPLATE"
            • "MARKETPLACE"
          • Distributor — (String)

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath — (Boolean)

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail — (String)

            The email contact information to obtain support for this Product.

          • SupportDescription — (String)

            The description of the support for this Product.

          • SupportUrl — (String)

            The URL information to obtain support for this Product.

        • Status — (String)

          The status of the product.

          • AVAILABLE - The product is ready for use.

          • CREATING - Product creation has started; the product is not ready for use.

          • FAILED - An action failed.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
        • ProductARN — (String)

          The ARN of the product.

        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

      • Tags — (Array<map>)

        Information about the tags associated with the product.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

Returns:

  • (AWS.Request) —

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

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

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

Service Reference:

Examples:

Calling the updateProvisionedProduct operation

var params = {
  UpdateToken: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PathId: 'STRING_VALUE',
  PathName: 'STRING_VALUE',
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisionedProductId: 'STRING_VALUE',
  ProvisionedProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE',
  ProvisioningParameters: [
    {
      Key: 'STRING_VALUE',
      UsePreviousValue: true || false,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  ProvisioningPreferences: {
    StackSetAccounts: [
      'STRING_VALUE',
      /* more items */
    ],
    StackSetFailureToleranceCount: 'NUMBER_VALUE',
    StackSetFailureTolerancePercentage: 'NUMBER_VALUE',
    StackSetMaxConcurrencyCount: 'NUMBER_VALUE',
    StackSetMaxConcurrencyPercentage: 'NUMBER_VALUE',
    StackSetOperationType: CREATE | UPDATE | DELETE,
    StackSetRegions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.updateProvisionedProduct(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisionedProductName — (String)

      The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    • ProvisionedProductId — (String)

      The identifier of the provisioned product. You must provide the name or ID, but not both.

    • ProductId — (String)

      The identifier of the product. You must provide the name or ID, but not both.

    • ProductName — (String)

      The name of the product. You must provide the name or ID, but not both.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • ProvisioningArtifactName — (String)

      The name of the provisioning artifact. You must provide the name or ID, but not both.

    • PathId — (String)

      The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.

    • PathName — (String)

      The name of the path. You must provide the name or ID, but not both.

    • ProvisioningParameters — (Array<map>)

      The new parameters.

      • Key — (String)

        The parameter key.

      • Value — (String)

        The parameter value.

      • UsePreviousValue — (Boolean)

        If set to true, Value is ignored and the previous parameter value is kept.

    • ProvisioningPreferences — (map)

      An object that contains information about the provisioning preferences for a stack set.

      • StackSetAccounts — (Array<String>)

        One or more AWS accounts that will have access to the provisioned product.

        Applicable only to a CFN_STACKSET provisioned product type.

        The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

        If no values are specified, the default value is all accounts from the STACKSET constraint.

      • StackSetRegions — (Array<String>)

        One or more AWS Regions where the provisioned product will be available.

        Applicable only to a CFN_STACKSET provisioned product type.

        The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

        If no values are specified, the default value is all regions from the STACKSET constraint.

      • StackSetFailureToleranceCount — (Integer)

        The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

        The default value is 0 if no value is specified.

      • StackSetFailureTolerancePercentage — (Integer)

        The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

        When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

      • StackSetMaxConcurrencyCount — (Integer)

        The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

      • StackSetMaxConcurrencyPercentage — (Integer)

        The maximum percentage of accounts in which to perform this operation at one time.

        When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

        Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

        Applicable only to a CFN_STACKSET provisioned product type.

        Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

      • StackSetOperationType — (String)

        Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

        Applicable only to a CFN_STACKSET provisioned product type.

        CREATE

        Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

        UPDATE

        Updates the stack set represented by the provisioned product and also its stack instances.

        DELETE

        Deletes a stack instance in the stack set represented by the provisioned product.

        Possible values include:
        • "CREATE"
        • "UPDATE"
        • "DELETE"
    • Tags — (Array<map>)

      One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • UpdateToken — (String)

      The idempotency token that uniquely identifies the provisioning update request.

      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:

      • RecordDetail — (map)

        Information about the result of the request.

        • RecordId — (String)

          The identifier of the record.

        • ProvisionedProductName — (String)

          The user-friendly name of the provisioned product.

        • Status — (String)

          The status of the provisioned product.

          • CREATED - The request was created but the operation has not started.

          • IN_PROGRESS - The requested operation is in progress.

          • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

          • SUCCEEDED - The requested operation has successfully completed.

          • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

          Possible values include:
          • "CREATED"
          • "IN_PROGRESS"
          • "IN_PROGRESS_IN_ERROR"
          • "SUCCEEDED"
          • "FAILED"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

        • RecordType — (String)

          The record type.

          • PROVISION_PRODUCT

          • UPDATE_PROVISIONED_PRODUCT

          • TERMINATE_PROVISIONED_PRODUCT

        • ProvisionedProductId — (String)

          The identifier of the provisioned product.

        • ProductId — (String)

          The product identifier.

        • ProvisioningArtifactId — (String)

          The identifier of the provisioning artifact.

        • PathId — (String)

          The path identifier.

        • RecordErrors — (Array<map>)

          The errors that occurred.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          One or more tags.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

        • LaunchRoleArn — (String)

          The ARN of the launch role associated with the provisioned product.

Returns:

  • (AWS.Request) —

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

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

Requests updates to the properties of the specified provisioned product.

Service Reference:

Examples:

Calling the updateProvisionedProductProperties operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  ProvisionedProductId: 'STRING_VALUE', /* required */
  ProvisionedProductProperties: { /* required */
    '<PropertyKey>': 'STRING_VALUE',
    /* '<PropertyKey>': ... */
  },
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.updateProvisionedProductProperties(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProvisionedProductId — (String)

      The identifier of the provisioned product.

    • ProvisionedProductProperties — (map<String>)

      A map that contains the provisioned product properties to be updated.

      The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call UpdateProvisionedProductProperties to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as UpdateProvisionedProduct, TerminateProvisionedProduct, or ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.

      The OWNER key accepts user ARNs and role ARNs. The owner is the user that has permission to see, update, terminate, and execute service actions in the provisioned product.

      The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product's history from when he was an owner using ListRecordHistory.

      If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

    • IdempotencyToken — (String)

      The idempotency token that uniquely identifies the provisioning product update request.

      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:

      • ProvisionedProductId — (String)

        The provisioned product identifier.

      • ProvisionedProductProperties — (map<String>)

        A map that contains the properties updated.

      • RecordId — (String)

        The identifier of the record.

      • Status — (String)

        The status of the request.

        Possible values include:
        • "CREATED"
        • "IN_PROGRESS"
        • "IN_PROGRESS_IN_ERROR"
        • "SUCCEEDED"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

Service Reference:

Examples:

Calling the updateProvisioningArtifact operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Active: true || false,
  Description: 'STRING_VALUE',
  Guidance: DEFAULT | DEPRECATED,
  Name: 'STRING_VALUE'
};
servicecatalog.updateProvisioningArtifact(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: {}) —
    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

    • ProductId — (String)

      The product identifier.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • Name — (String)

      The updated name of the provisioning artifact.

    • Description — (String)

      The updated description of the provisioning artifact.

    • Active — (Boolean)

      Indicates whether the product version is active.

      Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

    • Guidance — (String)

      Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

      The DEFAULT value indicates that the product version is active.

      The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

      Possible values include:
      • "DEFAULT"
      • "DEPRECATED"

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:

      • ProvisioningArtifactDetail — (map)

        Information about the provisioning artifact.

        • Id — (String)

          The identifier of the provisioning artifact.

        • Name — (String)

          The name of the provisioning artifact.

        • Description — (String)

          The description of the provisioning artifact.

        • Type — (String)

          The type of provisioning artifact.

          • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

          • MARKETPLACE_AMI - AWS Marketplace AMI

          • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

          Possible values include:
          • "CLOUD_FORMATION_TEMPLATE"
          • "MARKETPLACE_AMI"
          • "MARKETPLACE_CAR"
        • CreatedTime — (Date)

          The UTC time stamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

        • Guidance — (String)

          Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

          Possible values include:
          • "DEFAULT"
          • "DEPRECATED"
      • Info — (map<String>)

        The URL of the CloudFormation template in Amazon S3.

      • Status — (String)

        The status of the current request.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Updates a self-service action.

Service Reference:

Examples:

Calling the updateServiceAction operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Definition: {
    '<ServiceActionDefinitionKey>': 'STRING_VALUE',
    /* '<ServiceActionDefinitionKey>': ... */
  },
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
servicecatalog.updateServiceAction(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: {}) —
    • Id — (String)

      The self-service action identifier.

    • Name — (String)

      The self-service action name.

    • Definition — (map<String>)

      A map that defines the self-service action.

    • Description — (String)

      The self-service action description.

    • AcceptLanguage — (String)

      The language code.

      • en - English (default)

      • jp - Japanese

      • zh - Chinese

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:

      • ServiceActionDetail — (map)

        Detailed information about the self-service action.

        • ServiceActionSummary — (map)

          Summary information about the self-service action.

          • Id — (String)

            The self-service action identifier.

          • Name — (String)

            The self-service action name.

          • Description — (String)

            The self-service action description.

          • DefinitionType — (String)

            The self-service action definition type. For example, SSM_AUTOMATION.

            Possible values include:
            • "SSM_AUTOMATION"
        • Definition — (map<String>)

          A map that defines the self-service action.

Returns:

  • (AWS.Request) —

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

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

Updates the specified TagOption.

Service Reference:

Examples:

Calling the updateTagOption operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Active: true || false,
  Value: 'STRING_VALUE'
};
servicecatalog.updateTagOption(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: {}) —
    • Id — (String)

      The TagOption identifier.

    • Value — (String)

      The updated value.

    • Active — (Boolean)

      The updated active state.

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:

      • TagOptionDetail — (map)

        Information about the TagOption.

        • Key — (String)

          The TagOption key.

        • Value — (String)

          The TagOption value.

        • Active — (Boolean)

          The TagOption active state.

        • Id — (String)

          The TagOption identifier.

        • Owner — (String)

          The AWS account Id of the owner account that created the TagOption.

Returns:

  • (AWS.Request) —

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