The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier.

The identifier of the provisioning artifact.

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

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

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.

Undocumented member.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The identifier of the constraint.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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.

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

You cannot have both a LAUNCH and a STACKSET constraint.

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

NOTIFICATION

Specify the NotificationArns property as follows:

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

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

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

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

STACKSET

Specify the Parameters property as follows:

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

You cannot have both a LAUNCH and a STACKSET constraint.

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

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

TEMPLATE

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

The updated description of the constraint.

The identifier of the constraint.

The status of the current request.

Information about the constraint.

The constraint parameters.

The response's http status code.

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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.

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

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.

The name of the plan.

The plan type.

The product identifier.

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

The identifier of the provisioning artifact.

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.

The user-friendly name of the provisioned product.

The product identifier.

The identifier of the provisioning artifact.

The plan identifier.

The name of the plan.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The identifier of the provisioned product.

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

An idempotency token that uniquely identifies the execute request.

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

The response's http status code.

The contact URL for product support.

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

The distributor of the product.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The contact email for product support.

The description of the product.

One or more tags.

The support information about the product.

The name of the product.

The owner of the product.

The type of product.

The configuration of the provisioning artifact.

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.

Information about the product view.

Information about the provisioning artifact.

Information about the tags associated with the product.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The identifier of the copied product.

The status of the copy product operation.

The status message.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The self-service action description.

The self-service action name.

The service action definition type. For example, SSM_AUTOMATION.

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

Name

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

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

Version

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

AssumeRole

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

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

Parameters

The list of parameters in JSON format.

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

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.

An object containing information about the self-service action.

The response's http status code.

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

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

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

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

Information about the result of this request.

The response's http status code.

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

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

The identifier of the provisioning artifact.

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

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The new parameters.

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

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

One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

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

The idempotency token that uniquely identifies the provisioning update request.

Information about the result of the request.

The response's http status code.

The product name.

The identifier of the provisioning artifact.

Indicates whether a verbose level of detail is enabled.

The provisioning artifact name.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier.

The status of the current request.

The URL of the CloudFormation template in Amazon S3.

Information about the provisioning artifact.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier. For example, prod-abcdzk7xy33qa.

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

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

The response's http status code.

The search filter to scope the results.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

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

The maximum number of items to return with this call.

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

The records, in reverse chronological order.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

The plan identifier.

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

Information about the plan.

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

The response's http status code.

The resource identifier.

The TagOption identifier.

The response's http status code.

The TagOption key.

The TagOption value.

Information about the TagOption.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

The resource identifier.

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

Information about the associated budgets.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier.

The portfolio identifier.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

The product identifier.

The portfolio identifier.

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

Information about the constraints.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

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

Information about the product.

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

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

The response's http status code.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The identifier of the constraint.

The status of the current request.

Information about the constraint.

The constraint parameters.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier.

The configuration for the provisioning artifact.

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.

The status of the current request.

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

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

LoadTemplateFromURL

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

ImportFromPhysicalId

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

Information about the provisioning artifact.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

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

Information about the portfolios.

The response's http status code.

The name of the budget you want to disassociate.

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

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product view identifier.

Summary information about the product.

Information about the provisioning artifacts for the product.

The response's http status code.

The AWS account ID. For example, 123456789012.

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The portfolio identifier.

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

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The product identifier.

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

Information about the provisioning artifacts.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

The product identifier. For example, prod-abcdzk7xy33qa.

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

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

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

The response's http status code.

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

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

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

The maximum number of items to return with this call.

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

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

The product view aggregations.

Information about the product views.

The response's http status code.

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

The identifier of the provisioned product.

The self-service action identifier.

The parameters of the self-service action.

The response's http status code.

The search filters.

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

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

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

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese