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.

Sending a Request Using ServiceCatalog

var servicecatalog = new AWS.ServiceCatalog();
servicecatalog.acceptPortfolioShare(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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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'
};
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.

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.

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.

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.

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.

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

      Specify the RoleArn property as follows:

      \"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"

      NOTIFICATION

      Specify the NotificationArns property as follows:

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

      TEMPLATE

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

    • Type — (String)

      The type of constraint.

      • LAUNCH

      • NOTIFICATION

      • 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

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

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

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

      The tags to associate with the portfolio.

      • Keyrequired — (String)

        The tag key.

      • Valuerequired — (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 timestamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (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.

Service Reference:

Examples:

Calling the createPortfolioShare operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE'
};
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.

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.

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

Creates a product.

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',
    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.

    • ProductType — (String)

      The type of product.

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

      The tags to associate with the product.

      • Keyrequired — (String)

        The tag key.

      • Valuerequired — (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.

      • Inforequired — (map<String>)

        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/..."

      • 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"
    • 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 timestamp 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 timestamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

      • Tags — (Array<map>)

        Information about the tags associated with the product.

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (String)

          The value for this key.

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.

Service Reference:

Examples:

Calling the createProvisioningArtifact operation

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Parameters: { /* required */
    Info: { /* required */
      '<ProvisioningArtifactInfoKey>': 'STRING_VALUE',
      /* '<ProvisioningArtifactInfoKey>': ... */
    },
    Description: 'STRING_VALUE',
    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.

      • Inforequired — (map<String>)

        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/..."

      • 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"
    • 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 timestamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

      • Info — (map<String>)

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

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

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.

Returns:

  • (AWS.Request)

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

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

Deletes the specified constraint.

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.

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.

Service Reference:

Examples:

Calling the deletePortfolioShare operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

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.

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.

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.

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.

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

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

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

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 timestamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (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.

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 = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

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 timestamp of the creation time.

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 = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

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

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (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.

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 timestamp of the creation time.

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 = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

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 value is CFN_STACK.

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

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

          The current status message of the provisioned product.

        • CreatedTime — (Date)

          The UTC timestamp 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.

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 = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

    • 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 timestamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

      • 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 will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value" and tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Service Reference:

Examples:

Calling the describeProvisioningParameters operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PathId: '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.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

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

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.

      • ConstraintSummaries — (Array<map>)

        Information about the constraints used to provision the product.

        • Type — (String)

          The type of constraint.

          • LAUNCH

          • NOTIFICATION

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

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

Service Reference:

Examples:

Calling the describeRecord operation

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 0,
  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 timestamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported value is CFN_STACK.

        • RecordType — (String)

          The record type for this record.

          • 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 while processing the request.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          The tags associated with this record.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

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

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.

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.

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.

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.

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

Disassociates the specified TagOption from the specified resource.

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.

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: 0,
  PageToken: 'STRING_VALUE'
};
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.

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

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

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

      • 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: 0,
  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

            • TEMPLATE

          • Description — (String)

            The description of the constraint.

        • Tags — (Array<map>)

          The tags associated with this product path.

          • Keyrequired — (String)

            The tag key.

          • Valuerequired — (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.

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

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

Service Reference:

Examples:

Calling the listPortfolioAccess operation

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: '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.

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: 0,
  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 timestamp 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: 0,
  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 timestamp 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: 0,
  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.

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 timestamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

      • 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: 0,
  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 timestamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported value is CFN_STACK.

        • RecordType — (String)

          The record type for this record.

          • 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 while processing the request.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          The tags associated with this record.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

      • 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: 0,
  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.

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: 0,
  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.

      • 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 will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Service Reference:

Examples:

Calling the provisionProduct operation

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisionToken: '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',
      Value: '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.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

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

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

    • Tags — (Array<map>)

      The tags to use as provisioning options.

      • Keyrequired — (String)

        The tag key.

      • Valuerequired — (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 ProvisionProduct.

        • 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 timestamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported value is CFN_STACK.

        • RecordType — (String)

          The record type for this record.

          • 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 while processing the request.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          The tags associated with this record.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

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'
};
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.

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

Service Reference:

Examples:

Calling the scanProvisionedProducts operation

var params = {
  AcceptLanguage: 'STRING_VALUE',
  AccessLevelFilter: {
    Key: Account | Role | User,
    Value: 'STRING_VALUE'
  },
  PageSize: 0,
  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 value is CFN_STACK.

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

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

          The current status message of the provisioned product.

        • CreatedTime — (Date)

          The UTC timestamp 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.

      • 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: 0,
  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: 0,
  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 timestamp 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.

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'
};
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

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 timestamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported value is CFN_STACK.

        • RecordType — (String)

          The record type for this record.

          • 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 while processing the request.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          The tags associated with this record.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

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'
};
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.

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

          • TEMPLATE

        • Description — (String)

          The description of the constraint.

        • Owner — (String)

          The owner of the constraint.

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

      • Keyrequired — (String)

        The tag key.

      • Valuerequired — (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 timestamp of the creation time.

        • ProviderName — (String)

          The name of the portfolio provider.

      • Tags — (Array<map>)

        Information about the tags associated with the portfolio.

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (String)

          The value for this key.

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.

      • Keyrequired — (String)

        The tag key.

      • Valuerequired — (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 timestamp of the creation time.

      • Tags — (Array<map>)

        Information about the tags associated with the product.

        • Keyrequired — (String)

          The tag key.

        • Valuerequired — (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',
  ProductId: 'STRING_VALUE',
  ProvisionedProductId: 'STRING_VALUE',
  ProvisionedProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningParameters: [
    {
      Key: 'STRING_VALUE',
      UsePreviousValue: true || false,
      Value: 'STRING_VALUE'
    },
    /* 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 updated 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.

    • ProductId — (String)

      The identifier of the provisioned product.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

    • PathId — (String)

      The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.

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

    • UpdateToken — (String)

      The idempotency token that uniquely identifies the provisioning update rquest.

      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 timestamp of the creation time.

        • UpdatedTime — (Date)

          The time when the record was last updated.

        • ProvisionedProductType — (String)

          The type of provisioned product. The supported value is CFN_STACK.

        • RecordType — (String)

          The record type for this record.

          • 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 while processing the request.

          • Code — (String)

            The numeric value of the error.

          • Description — (String)

            The description of the error.

        • RecordTags — (Array<map>)

          The tags associated with this record.

          • Key — (String)

            The key for this tag.

          • Value — (String)

            The value for this tag.

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',
  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.

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 timestamp of the creation time.

        • Active — (Boolean)

          Indicates whether the product version is active.

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

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.

Returns:

  • (AWS.Request)

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