Class: AWS.ServiceCatalog

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

Parameters:

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

    The name of the budget you want to associate.

  • ResourceId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    • jp - Japanese

    • zh - Chinese

  • PortfolioId — (String)

    The portfolio identifier.

  • PrincipalARN — (String)

    The ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a fully defined IAM Amazon Resource Name (ARN). If the PrincipalType is IAM_PATTERN, the supported value is an IAM ARN without an AccountID in the following format:

    arn:partition:iam:::resource-type/resource-id

    The ARN resource-id can be either:

    • A fully formed resource-id. For example, arn:aws:iam:::role/resource-name or arn:aws:iam:::role/resource-path/resource-name

    • A wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a "" or "?" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. The new symbols are exclusive to the resource-path and resource-name and cannot replace the resource-type or other ARN values.

      The ARN path and principal name allow unlimited wildcard characters.

    Examples of an acceptable wildcard ARN:

    • arn:aws:iam:::role/ResourceName_

    • arn:aws:iam:::role//ResourceName_?

    Examples of an unacceptable wildcard ARN:

    • arn:aws:iam:::/ResourceName

    You can associate multiple IAM_PATTERNs even if the account has no principal with that name.

    The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "" wildcard character matches any number of any characters. This is similar to "." in regular regex context.

    In the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), valid resource-type values include user/, group/, or role/. The "?" and "" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.

    The "" character also matches the "/" character, allowing paths to be formed within the resource-id. For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 and arn:aws:iam:::role/pathA/ResourceName_1.

  • PrincipalType — (String)

    The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name (ARN), or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

    Possible values include:
    • "IAM"
    • "IAM_PATTERN"

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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.

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

var params = {
  ProductId: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  ServiceActionId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  IdempotencyToken: 'STRING_VALUE'
};
servicecatalog.associateServiceActionWithProvisioningArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The product identifier. For example, prod-abcdzk7xy33qa.

  • ProvisioningArtifactId — (String)

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

  • ServiceActionId — (String)

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

  • AcceptLanguage — (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • IdempotencyToken — (String)

    A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same 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.

Returns:

• (AWS.Request) —

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

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.

var params = {
  ServiceActionAssociations: [ /* required */
    {
      ProductId: 'STRING_VALUE', /* required */
      ProvisioningArtifactId: 'STRING_VALUE', /* required */
      ServiceActionId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.batchAssociateServiceActionWithProvisioningArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ServiceActionAssociations — (Array<map>)

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

    • ServiceActionId — required — (String)

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

    • ProductId — required — (String)

      The product identifier. For example, prod-abcdzk7xy33qa.

    • ProvisioningArtifactId — required — (String)

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

  • AcceptLanguage — (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • FailedServiceActionAssociations — (Array<map>)

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

      • ServiceActionId — (String)

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

      • ProductId — (String)

        The product identifier. For example, prod-abcdzk7xy33qa.

      • ProvisioningArtifactId — (String)

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

      • ErrorCode — (String)

        The error code. Valid values are listed below.

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

        A text description of the error.

Returns:

• (AWS.Request) —

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

var params = {
  ServiceActionAssociations: [ /* required */
    {
      ProductId: 'STRING_VALUE', /* required */
      ProvisioningArtifactId: 'STRING_VALUE', /* required */
      ServiceActionId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  AcceptLanguage: 'STRING_VALUE'
};
servicecatalog.batchDisassociateServiceActionFromProvisioningArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ServiceActionAssociations — (Array<map>)

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

    • ServiceActionId — required — (String)

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

    • ProductId — required — (String)

      The product identifier. For example, prod-abcdzk7xy33qa.

    • ProvisioningArtifactId — required — (String)

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

  • AcceptLanguage — (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • FailedServiceActionAssociations — (Array<map>)

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

      • ServiceActionId — (String)

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

      • ProductId — (String)

        The product identifier. For example, prod-abcdzk7xy33qa.

      • ProvisioningArtifactId — (String)

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

      • ErrorCode — (String)

        The error code. Valid values are listed below.

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

        A text description of the error.

Returns:

• (AWS.Request) —

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

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.

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

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.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId — (String)

    The portfolio identifier.

  • ProductId — (String)

    The product identifier.

  • Parameters — (String)

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

    LAUNCH

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

    Specify the RoleArn property as follows:

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

    Specify the LocalRoleName property as follows:

    {"LocalRoleName": "SCBasicLaunchRole"}

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

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

    You cannot have both a LAUNCH and a STACKSET constraint.

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

    NOTIFICATION

    Specify the NotificationArns property as follows:

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

    RESOURCE_UPDATE

    Specify the TagUpdatesOnProvisionedProduct property as follows:

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

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

    STACKSET

    Specify the Parameters property as follows:

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

    You cannot have both a LAUNCH and a STACKSET constraint.

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

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

    TEMPLATE

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

  • Type — (String)

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • RESOURCE_UPDATE

    • STACKSET

    • TEMPLATE

  • Description — (String)

    The description of the constraint.

  • IdempotencyToken — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ConstraintDetail — (map)

      Information about the constraint.

      • ConstraintId — (String)

        The identifier of the constraint.

      • Type — (String)

        The type of constraint.

        • LAUNCH

        • NOTIFICATION

        • STACKSET

        • TEMPLATE

      • Description — (String)

        The description of the constraint.

      • Owner — (String)

        The owner of the constraint.

      • ProductId — (String)

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

      • PortfolioId — (String)

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

    • ConstraintParameters — (String)

      The constraint parameters.

    • Status — (String)

      The status of the current request.

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

Returns:

• (AWS.Request) —

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

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.

    • jp - Japanese

    • zh - Chinese

  • DisplayName — (String)

    The name to use for display purposes.

  • Description — (String)

    The description of the portfolio.

  • ProviderName — (String)

    The name of the portfolio provider.

  • Tags — (Array<map>)

    One or more tags.

    • Key — required — (String)

      The tag key.

    • Value — required — (String)

      The value for this key.

  • IdempotencyToken — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PortfolioDetail — (map)

      Information about the portfolio.

      • Id — (String)

        The portfolio identifier.

      • ARN — (String)

        The ARN assigned to the portfolio.

      • DisplayName — (String)

        The name to use for display purposes.

      • Description — (String)

        The description of the portfolio.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • ProviderName — (String)

        The name of the portfolio provider.

    • Tags — (Array<map>)

      Information about the tags associated with the portfolio.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

Returns:

• (AWS.Request) —

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

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AccountId: 'STRING_VALUE',
  OrganizationNode: {
    Type: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT,
    Value: 'STRING_VALUE'
  },
  SharePrincipals: true || false,
  ShareTagOptions: true || false
};
servicecatalog.createPortfolioShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId — (String)

    The portfolio identifier.

  • AccountId — (String)

    The Amazon Web Services account ID. For example, 123456789012.

  • OrganizationNode — (map)

    The organization node to whom you are going to share. When you pass OrganizationNode, it creates PortfolioShare for all of the Amazon Web Services accounts that are associated to the OrganizationNode. The output returns a PortfolioShareToken, which enables the administrator to monitor the status of the PortfolioShare creation process.

    • Type — (String)

      The organization node type.

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

      The identifier of the organization node.

  • ShareTagOptions — (Boolean)

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

  • SharePrincipals — (Boolean)

    This parameter is only supported for portfolios with an OrganizationalNode Type of ORGANIZATION or ORGANIZATIONAL_UNIT.

    Enables or disables Principal sharing when creating the portfolio share. If you do not provide this flag, principal sharing is disabled.

    When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of PrincipalType: IAM_PATTERN on their portfolio. You can create the principals in the recipient account before or after creating the share.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PortfolioShareToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Owner: 'STRING_VALUE', /* required */
  ProductType: CLOUD_FORMATION_TEMPLATE | MARKETPLACE | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNAL, /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Distributor: 'STRING_VALUE',
  ProvisioningArtifactParameters: {
    Description: 'STRING_VALUE',
    DisableTemplateValidation: true || false,
    Info: {
      '<ProvisioningArtifactInfoKey>': 'STRING_VALUE',
      /* '<ProvisioningArtifactInfoKey>': ... */
    },
    Name: 'STRING_VALUE',
    Type: CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNAL
  },
  SourceConnection: {
    ConnectionParameters: { /* required */
      CodeStar: {
        ArtifactPath: 'STRING_VALUE', /* required */
        Branch: 'STRING_VALUE', /* required */
        ConnectionArn: 'STRING_VALUE', /* required */
        Repository: 'STRING_VALUE' /* required */
      }
    },
    Type: CODESTAR
  },
  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.

    • jp - Japanese

    • zh - Chinese

  • Name — (String)

    The name of the product.

  • Owner — (String)

    The owner of the product.

  • Description — (String)

    The description of the product.

  • Distributor — (String)

    The distributor of the product.

  • SupportDescription — (String)

    The support information about the product.

  • SupportEmail — (String)

    The contact email for product support.

  • SupportUrl — (String)

    The contact URL for product support.

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

  • ProductType — (String)

    The type of product.

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

    One or more tags.

    • Key — required — (String)

      The tag key.

    • Value — required — (String)

      The value for this key.

  • ProvisioningArtifactParameters — (map)

    The configuration of the provisioning artifact.

    • Name — (String)

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

    • Description — (String)

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

    • Info — (map<String>)

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

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

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

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

    • Type — (String)

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

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

      Service Catalog does not support template validation for the TERRAFORM_OS product type.

  • 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.
  • SourceConnection — (map)

    Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.

    • Type

    • ConnectionParamters

    • Type — (String)

      The only supported SourceConnection type is Codestar.

      Possible values include:
      • "CODESTAR"
    • ConnectionParameters — required — (map)

      The connection details based on the connection Type.

      • CodeStar — (map)

        Provides ConnectionType details.

        • ConnectionArn — required — (String)

          The CodeStar ARN, which is the connection between Service Catalog and the external repository.

        • Repository — required — (String)

          The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

        • Branch — required — (String)

          The specific branch where the artifact resides.

        • ArtifactPath — required — (String)

          The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

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 Amazon Web Services Marketplace.

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

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

        • HasDefaultPath — (Boolean)

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

        • SupportEmail — (String)

          The email contact information to obtain support for this Product.

        • SupportDescription — (String)

          The description of the support for this Product.

        • SupportUrl — (String)

          The URL information to obtain support for this Product.

      • Status — (String)

        The status of the product.

        • AVAILABLE - The product is ready for use.

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

        • FAILED - An action failed.

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

        The ARN of the product.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • SourceConnection — (map)

        A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

        • Type — (String)

          The only supported SourceConnection type is Codestar.

          Possible values include:
          • "CODESTAR"
        • ConnectionParameters — (map)

          The connection details based on the connection Type.

          • CodeStar — (map)

            Provides ConnectionType details.

            • ConnectionArn — required — (String)

              The CodeStar ARN, which is the connection between Service Catalog and the external repository.

            • Repository — required — (String)

              The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

            • Branch — required — (String)

              The specific branch where the artifact resides.

            • ArtifactPath — required — (String)

              The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

        • LastSync — (map)

          Provides details about the product's connection sync and contains the following sub-fields.

          • LastSyncTime

          • LastSyncStatus

          • LastSyncStatusMessage

          • LastSuccessfulSyncTime

          • LastSuccessfulSyncProvisioningArtifactID

          • LastSyncTime — (Date)

            The time of the last attempted sync from the repository to the Service Catalog product.

          • LastSyncStatus — (String)

            The current status of the sync. Responses include SUCCEEDED or FAILED.

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

            The sync's status message.

          • LastSuccessfulSyncTime — (Date)

            The time of the latest successful sync from the source repo artifact to the Service Catalog product.

          • LastSuccessfulSyncProvisioningArtifactId — (String)

            The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

    • 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 - CloudFormation template

        • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

        • TERRAFORM_CLOUD - Terraform Cloud configuration file

        • EXTERNAL - External configuration file

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

        The UTC time stamp of the creation time.

      • Active — (Boolean)

        Indicates whether the product version is active.

      • Guidance — (String)

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

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

        Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

        This field only exists for Repo-Synced products.

    • Tags — (Array<map>)

      Information about the tags associated with the product.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

Returns:

• (AWS.Request) —

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

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  PlanName: 'STRING_VALUE', /* required */
  PlanType: CLOUDFORMATION, /* required */
  ProductId: 'STRING_VALUE', /* required */
  ProvisionedProductName: 'STRING_VALUE', /* required */
  ProvisioningArtifactId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  NotificationArns: [
    'STRING_VALUE',
    /* more items */
  ],
  PathId: 'STRING_VALUE',
  ProvisioningParameters: [
    {
      Key: 'STRING_VALUE',
      UsePreviousValue: true || false,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicecatalog.createProvisionedProductPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PlanName — (String)

    The name of the plan.

  • PlanType — (String)

    The plan type.

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

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

  • PathId — (String)

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

  • ProductId — (String)

    The product identifier.

  • ProvisionedProductName — (String)

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

  • ProvisioningArtifactId — (String)

    The identifier of the provisioning artifact.

  • ProvisioningParameters — (Array<map>)

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

    • Key — (String)

      The parameter key.

    • Value — (String)

      The parameter value.

    • UsePreviousValue — (Boolean)

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

  • IdempotencyToken — (String)

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

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

    One or more tags.

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

    • Key — required — (String)

      The tag key.

    • Value — required — (String)

      The value for this key.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PlanName — (String)

      The name of the plan.

    • PlanId — (String)

      The plan identifier.

    • ProvisionProductId — (String)

      The product identifier.

    • ProvisionedProductName — (String)

      The user-friendly name of the provisioned product.

    • ProvisioningArtifactId — (String)

      The identifier of the provisioning artifact.

Returns:

• (AWS.Request) —

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

var params = {
  IdempotencyToken: 'STRING_VALUE', /* required */
  Parameters: { /* required */
    Description: 'STRING_VALUE',
    DisableTemplateValidation: true || false,
    Info: {
      '<ProvisioningArtifactInfoKey>': 'STRING_VALUE',
      /* '<ProvisioningArtifactInfoKey>': ... */
    },
    Name: 'STRING_VALUE',
    Type: CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNAL
  },
  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.

    • jp - Japanese

    • zh - Chinese

  • ProductId — (String)

    The product identifier.

  • Parameters — (map)

    The configuration for the provisioning artifact.

    • Name — (String)

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

    • Description — (String)

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

    • Info — (map<String>)

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

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

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

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

    • Type — (String)

      The type of provisioning artifact.

      • CLOUD_FORMATION_TEMPLATE - CloudFormation template

      • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

      • TERRAFORM_CLOUD - Terraform Cloud configuration file

      • EXTERNAL - External configuration file

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

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

      Service Catalog does not support template validation for the TERRAFORM_OS product type.

  • 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 - CloudFormation template

        • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

        • TERRAFORM_CLOUD - Terraform Cloud configuration file

        • EXTERNAL - External configuration file

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

        The UTC time stamp of the creation time.

      • Active — (Boolean)

        Indicates whether the product version is active.

      • Guidance — (String)

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

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

        Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

        This field only exists for Repo-Synced products.

    • Info — (map<String>)

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

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

      LoadTemplateFromURL

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

      ImportFromPhysicalId

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

    • Status — (String)

      The status of the current request.

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

Returns:

• (AWS.Request) —

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

var params = {
  Definition: { /* required */
    '<ServiceActionDefinitionKey>': 'STRING_VALUE',
    /* '<ServiceActionDefinitionKey>': ... */
  },
  DefinitionType: SSM_AUTOMATION, /* required */
  IdempotencyToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  Description: 'STRING_VALUE'
};
servicecatalog.createServiceAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The self-service action name.

  • DefinitionType — (String)

    The service action definition type. For example, SSM_AUTOMATION.

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

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

    Name

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

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

    Version

    The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

    AssumeRole

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

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

    Parameters

    The list of parameters in JSON format.

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

  • Description — (String)

    The self-service action description.

  • AcceptLanguage — (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • IdempotencyToken — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ServiceActionDetail — (map)

      An object containing information about the self-service action.

      • ServiceActionSummary — (map)

        Summary information about the self-service action.

        • Id — (String)

          The self-service action identifier.

        • Name — (String)

          The self-service action name.

        • Description — (String)

          The self-service action description.

        • DefinitionType — (String)

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

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

        A map that defines the self-service action.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The TagOption key.

  • Value — (String)

    The TagOption value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • TagOptionDetail — (map)

      Information about the TagOption.

      • Key — (String)

        The TagOption key.

      • Value — (String)

        The TagOption value.

      • Active — (Boolean)

        The TagOption active state.

      • Id — (String)

        The TagOption identifier.

      • Owner — (String)

        The Amazon Web Services account Id of the owner account that created the TagOption.

Returns:

• (AWS.Request) —

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

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.

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

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.

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

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  AccountId: 'STRING_VALUE',
  OrganizationNode: {
    Type: ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT,
    Value: 'STRING_VALUE'
  }
};
servicecatalog.deletePortfolioShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PortfolioId — (String)

    The portfolio identifier.

  • AccountId — (String)

    The Amazon Web Services account ID.

  • OrganizationNode — (map)

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

    • Type — (String)

      The organization node type.

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

      The identifier of the organization node.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PortfolioShareToken — (String)

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

Returns:

• (AWS.Request) —

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

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.

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

var params = {
  PlanId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  IgnoreErrors: true || false
};
servicecatalog.deleteProvisionedProductPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PlanId — (String)

    The plan identifier.

  • IgnoreErrors — (Boolean)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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.

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

var params = {
  Id: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  IdempotencyToken: 'STRING_VALUE'
};
servicecatalog.deleteServiceAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • AcceptLanguage — (String)

    The language code.

    • jp - Japanese

    • zh - Chinese

  • IdempotencyToken — (String)

    A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same 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.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The TagOption identifier.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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.

    • jp - Japanese

    • zh - Chinese

  • Id — (String)

    The identifier of the constraint.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ConstraintDetail — (map)

      Information about the constraint.

      • ConstraintId — (String)

        The identifier of the constraint.

      • Type — (String)

        The type of constraint.

        • LAUNCH

        • NOTIFICATION

        • STACKSET

        • TEMPLATE

      • Description — (String)

        The description of the constraint.

      • Owner — (String)

        The owner of the constraint.

      • ProductId — (String)

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

      • PortfolioId — (String)

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

    • ConstraintParameters — (String)

      The constraint parameters.

    • Status — (String)

      The status of the current request.

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

Returns:

• (AWS.Request) —

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

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.

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

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.

    • jp - Japanese

    • zh - Chinese

  • Id — (String)

    The portfolio identifier.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PortfolioDetail — (map)

      Information about the portfolio.

      • Id — (String)

        The portfolio identifier.

      • ARN — (String)

        The ARN assigned to the portfolio.

      • DisplayName — (String)

        The name to use for display purposes.

      • Description — (String)

        The description of the portfolio.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • ProviderName — (String)

        The name of the portfolio provider.

    • Tags — (Array<map>)

      Information about the tags associated with the portfolio.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • TagOptions — (Array<map>)

      Information about the TagOptions associated with the portfolio.

      • Key — (String)

        The TagOption key.

      • Value — (String)

        The TagOption value.

      • Active — (Boolean)

        The TagOption active state.

      • Id — (String)

        The TagOption identifier.

      • Owner — (String)

        The Amazon Web Services account Id of the owner account that created the TagOption.

    • Budgets — (Array<map>)

      Information about the associated budgets.

      • BudgetName — (String)

        Name of the associated budget.

Returns:

• (AWS.Request) —

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

var params = {
  PortfolioId: 'STRING_VALUE', /* required */
  Type: ACCOUNT | ORGANIZATION | ORGANIZATIONAL_UNIT | ORGANIZATION_MEMBER_ACCOUNT, /* required */
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.describePortfolioShares(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

  • Type — (String)

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

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

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

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

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

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

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

  • PageSize — (Integer)

    The maximum number of items to return with this call.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • NextPageToken — (String)

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

    • PortfolioShareDetails — (Array<map>)

      Summaries about each of the portfolio shares.

      • PrincipalId — (String)

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

        1. An external account.

        2. An organziation member account.

        3. An organzational unit (OU).

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

      • Type — (String)

        The type of the portfolio share.

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

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

      • ShareTagOptions — (Boolean)

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

      • SharePrincipals — (Boolean)

        Indicates if Principal sharing is enabled or disabled for the portfolio share.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • PortfolioShareToken — (String)

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

    • PortfolioId — (String)

      The portfolio identifier.

    • OrganizationNodeValue — (String)

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

    • Status — (String)

      Status of the portfolio share operation.

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

      Information about the portfolio share operation.

      • SuccessfulShares — (Array<String>)

        List of accounts for whom the operation succeeded.

      • ShareErrors — (Array<map>)

        List of errors.

        • Accounts — (Array<String>)

          List of accounts impacted by the error.

        • Message — (String)

          Information about the error.

        • Error — (String)

          Error type that happened when processing the operation.

Returns:

• (AWS.Request) —

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

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
servicecatalog.describeProduct(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • Id — (String)

    The product identifier.

  • Name — (String)

    The product name.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProductViewSummary — (map)

      Summary information about the product view.

      • Id — (String)

        The product view identifier.

      • ProductId — (String)

        The product identifier.

      • Name — (String)

        The name of the product.

      • Owner — (String)

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

      • ShortDescription — (String)

        Short description of the product.

      • Type — (String)

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

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

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

      • HasDefaultPath — (Boolean)

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

      • SupportEmail — (String)

        The email contact information to obtain support for this Product.

      • SupportDescription — (String)

        The description of the support for this Product.

      • SupportUrl — (String)

        The URL information to obtain support for this Product.

    • ProvisioningArtifacts — (Array<map>)

      Information about the provisioning artifacts for the specified product.

      • Id — (String)

        The identifier of the provisioning artifact.

      • Name — (String)

        The name of the provisioning artifact.

      • Description — (String)

        The description of the provisioning artifact.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • Guidance — (String)

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

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

      Information about the associated budgets.

      • BudgetName — (String)

        Name of the associated budget.

    • LaunchPaths — (Array<map>)

      Information about the associated launch paths.

      • Id — (String)

        The identifier of the launch path.

      • Name — (String)

        The name of the launch path.

Returns:

• (AWS.Request) —

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

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  SourcePortfolioId: 'STRING_VALUE'
};
servicecatalog.describeProductAsAdmin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • Id — (String)

    The product identifier.

  • Name — (String)

    The product name.

  • SourcePortfolioId — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProductViewDetail — (map)

      Information about the product view.

      • ProductViewSummary — (map)

        Summary information about the product view.

        • Id — (String)

          The product view identifier.

        • ProductId — (String)

          The product identifier.

        • Name — (String)

          The name of the product.

        • Owner — (String)

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

        • ShortDescription — (String)

          Short description of the product.

        • Type — (String)

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

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

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

        • HasDefaultPath — (Boolean)

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

        • SupportEmail — (String)

          The email contact information to obtain support for this Product.

        • SupportDescription — (String)

          The description of the support for this Product.

        • SupportUrl — (String)

          The URL information to obtain support for this Product.

      • Status — (String)

        The status of the product.

        • AVAILABLE - The product is ready for use.

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

        • FAILED - An action failed.

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

        The ARN of the product.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • SourceConnection — (map)

        A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

        • Type — (String)

          The only supported SourceConnection type is Codestar.

          Possible values include:
          • "CODESTAR"
        • ConnectionParameters — (map)

          The connection details based on the connection Type.

          • CodeStar — (map)

            Provides ConnectionType details.

            • ConnectionArn — required — (String)

              The CodeStar ARN, which is the connection between Service Catalog and the external repository.

            • Repository — required — (String)

              The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."

            • Branch — required — (String)

              The specific branch where the artifact resides.

            • ArtifactPath — required — (String)

              The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."

        • LastSync — (map)

          Provides details about the product's connection sync and contains the following sub-fields.

          • LastSyncTime

          • LastSyncStatus

          • LastSyncStatusMessage

          • LastSuccessfulSyncTime

          • LastSuccessfulSyncProvisioningArtifactID

          • LastSyncTime — (Date)

            The time of the last attempted sync from the repository to the Service Catalog product.

          • LastSyncStatus — (String)

            The current status of the sync. Responses include SUCCEEDED or FAILED.

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

            The sync's status message.

          • LastSuccessfulSyncTime — (Date)

            The time of the latest successful sync from the source repo artifact to the Service Catalog product.

          • LastSuccessfulSyncProvisioningArtifactId — (String)

            The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.

    • ProvisioningArtifactSummaries — (Array<map>)

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

      • Id — (String)

        The identifier of the provisioning artifact.

      • Name — (String)

        The name of the provisioning artifact.

      • Description — (String)

        The description of the provisioning artifact.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • ProvisioningArtifactMetadata — (map<String>)

        The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.

    • Tags — (Array<map>)

      Information about the tags associated with the product.

      • Key — required — (String)

        The tag key.

      • Value — required — (String)

        The value for this key.

    • TagOptions — (Array<map>)

      Information about the TagOptions associated with the product.

      • Key — (String)

        The TagOption key.

      • Value — (String)

        The TagOption value.

      • Active — (Boolean)

        The TagOption active state.

      • Id — (String)

        The TagOption identifier.

      • Owner — (String)

        The Amazon Web Services account Id of the owner account that created the TagOption.

    • Budgets — (Array<map>)

      Information about the associated budgets.

      • BudgetName — (String)

        Name of the associated budget.

Returns:

• (AWS.Request) —

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

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.

    • 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 Amazon Web Services Marketplace.

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

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

      • HasDefaultPath — (Boolean)

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

      • SupportEmail — (String)

        The email contact information to obtain support for this Product.

      • SupportDescription — (String)

        The description of the support for this Product.

      • SupportUrl — (String)

        The URL information to obtain support for this Product.

    • ProvisioningArtifacts — (Array<map>)

      Information about the provisioning artifacts for the product.

      • Id — (String)

        The identifier of the provisioning artifact.

      • Name — (String)

        The name of the provisioning artifact.

      • Description — (String)

        The description of the provisioning artifact.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • Guidance — (String)

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

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

Returns:

• (AWS.Request) —

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

var params = {
  AcceptLanguage: 'STRING_VALUE',
  Id: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
servicecatalog.describeProvisionedProduct(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • Id — (String)

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

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

  • Name — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProvisionedProductDetail — (map)

      Information about the provisioned product.

      • Name — (String)

        The user-friendly name of the provisioned product.

      • Arn — (String)

        The ARN of the provisioned product.

      • Type — (String)

        The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

      • Id — (String)

        The identifier of the provisioned product.

      • Status — (String)

        The current status of the provisioned product.

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

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

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

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

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

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

        The current status message of the provisioned product.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • IdempotencyToken — (String)

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

      • LastRecordId — (String)

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

      • LastProvisioningRecordId — (String)

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

        • ProvisionProduct

        • UpdateProvisionedProduct

        • ExecuteProvisionedProductPlan

        • TerminateProvisionedProduct

      • LastSuccessfulProvisioningRecordId — (String)

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

        • ProvisionProduct

        • UpdateProvisionedProduct

        • ExecuteProvisionedProductPlan

        • TerminateProvisionedProduct

      • ProductId — (String)

        The product identifier. For example, prod-abcdzk7xy33qa.

      • ProvisioningArtifactId — (String)

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

      • LaunchRoleArn — (String)

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

    • CloudWatchDashboards — (Array<map>)

      Any CloudWatch dashboards that were created when provisioning the product.

      • Name — (String)

        The name of the CloudWatch dashboard.

Returns:

• (AWS.Request) —

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

var params = {
  PlanId: 'STRING_VALUE', /* required */
  AcceptLanguage: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PageToken: 'STRING_VALUE'
};
servicecatalog.describeProvisionedProductPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • PlanId — (String)

    The plan identifier.

  • PageSize — (Integer)

    The maximum number of items to return with this call.

  • PageToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProvisionedProductPlanDetails — (map)

      Information about the plan.

      • CreatedTime — (Date)

        The UTC time stamp of the creation time.

      • PathId — (String)

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

      • ProductId — (String)

        The product identifier.

      • PlanName — (String)

        The name of the plan.

      • PlanId — (String)

        The plan identifier.

      • ProvisionProductId — (String)

        The product identifier.

      • ProvisionProductName — (String)

        The user-friendly name of the provisioned product.

      • PlanType — (String)

        The plan type.

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

        The identifier of the provisioning artifact.

      • Status — (String)

        The status.

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

        The UTC time stamp when the plan was last updated.

      • NotificationArns — (Array<String>)

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

      • ProvisioningParameters — (Array<map>)

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

        • Key — (String)

          The parameter key.

        • Value — (String)

          The parameter value.

        • UsePreviousValue — (Boolean)

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

      • Tags — (Array<map>)

        One or more tags.

        • Key — required — (String)

          The tag key.

        • Value — required — (String)

          The value for this key.

      • StatusMessage — (String)

        The status message.

    • ResourceChanges — (Array<map>)

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

      • Action — (String)

        The change action.

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

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

      • PhysicalResourceId — (String)

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

      • ResourceType — (String)

        The type of resource.

      • Replacement — (String)

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

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

        The change scope.

      • Details — (Array<map>)

        Information about the resource changes.

        • Target — (map)

          Information about the resource attribute to be modified.

          • Attribute — (String)

            The attribute to be changed.

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

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

          • RequiresRecreation — (String)

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

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

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

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

          The ID of the entity that caused the change.

    • NextPageToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  AcceptLanguage: 'STRING_VALUE',
  IncludeProvisioningArtifactParameters: true || false,
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE',
  Verbose: true || false
};
servicecatalog.describeProvisioningArtifact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProvisioningArtifactId — (String)

    The identifier of the provisioning artifact.

  • ProductId — (String)

    The product identifier.

  • ProvisioningArtifactName — (String)

    The provisioning artifact name.

  • ProductName — (String)

    The product name.

  • Verbose — (Boolean)

    Indicates whether a verbose level of detail is enabled.

  • IncludeProvisioningArtifactParameters — (Boolean)

    Indicates if the API call response does or does not include additional details about the provisioning parameters.

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 - CloudFormation template

        • TERRAFORM_OPEN_SOURCE - Terraform Open Source configuration file

        • TERRAFORM_CLOUD - Terraform Cloud configuration file

        • EXTERNAL - External configuration file

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

        The UTC time stamp of the creation time.

      • Active — (Boolean)

        Indicates whether the product version is active.

      • Guidance — (String)

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

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

        Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.

        This field only exists for Repo-Synced products.

    • Info — (map<String>)

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

    • Status — (String)

      The status of the current request.

      Possible values include:
      • "AVAILABLE"
      • "CREATING"
      • "FAILED"
    • ProvisioningArtifactParameters — (Array<map>)

      Information about the parameters used to provision the product.

      • ParameterKey — (String)

        The parameter key.

      • DefaultValue — (String)

        The default value.

      • ParameterType — (String)

        The parameter type.

      • IsNoEcho — (Boolean)

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

      • Description — (String)

        The description of the parameter.

      • ParameterConstraints — (map)

        Constraints that the administrator has put on a parameter.

        • AllowedValues — (Array<String>)

          The values that the administrator has allowed for the parameter.

        • AllowedPattern — (String)

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

        • ConstraintDescription — (String)

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

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

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

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

        • MaxLength — (String)

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

        • MinLength — (String)

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

        • MaxValue — (String)

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

        • MinValue — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  AcceptLanguage: 'STRING_VALUE',
  PathId: 'STRING_VALUE',
  PathName: 'STRING_VALUE',
  ProductId: 'STRING_VALUE',
  ProductName: 'STRING_VALUE',
  ProvisioningArtifactId: 'STRING_VALUE',
  ProvisioningArtifactName: 'STRING_VALUE'
};
servicecatalog.describeProvisioningParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProductId — (String)

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

  • ProductName — (String)

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

  • ProvisioningArtifactId — (String)

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

  • ProvisioningArtifactName — (String)

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

  • PathId — (String)

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

  • PathName — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ProvisioningArtifactParameters — (Array<map>)

      Information about the parameters used to provision the product.

      • ParameterKey — (String)

        The parameter key.

      • DefaultValue — (String)

        The default value.

      • ParameterType — (String)

        The parameter type.

      • IsNoEcho — (Boolean)

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

      • Description — (String)

        The description of the parameter.

      • ParameterConstraints — (map)

        Constraints that the administrator has put on a parameter.

        • AllowedValues — (Array<String>)

          The values that the administrator has allowed for the parameter.

        • AllowedPattern — (String)

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

        • ConstraintDescription — (String)

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

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

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

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

        • MaxLength — (String)

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

        • MinLength — (String)

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

        • MaxValue — (String)

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

        • MinValue — (String)

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

    • ConstraintSummaries — (Array<map>)

      Information about the constraints used to provision the product.

      • Type — (String)

        The type of constraint.

        • LAUNCH

        • NOTIFICATION

        • STACKSET

        • TEMPLATE

      • Description — (String)

        The description of the constraint.

    • UsageInstructions — (Array<map>)

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

      • Type — (String)

        The usage instruction type for the value.

      • Value — (String)

        The usage instruction value for this type.

    • TagOptions — (Array<map>)

      Information about the TagOptions associated with the resource.

      • Key — (String)

        The TagOption key.

      • Values — (Array<String>)

        The TagOption value.

    • ProvisioningArtifactPreferences — (map)

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

      • StackSetAccounts — (Array<String>)

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

        Applicable only to a CFN_STACKSET provisioned product type.

      • StackSetRegions — (Array<String>)

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

        Applicable only to a CFN_STACKSET provisioned product type.

    • ProvisioningArtifactOutputs — (Array<map>)

      The output of the provisioning artifact.

      • Key — (String)

        The provisioning artifact output key.

      • Description — (String)

        Description of the provisioning artifact output key.

    • ProvisioningArtifactOutputKeys — (Array<map>)

      A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.

      • Key — (String)

        The provisioning artifact output key.

      • Description — (String)

        Description of the provisioning artifact output key.