String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String portfolioShareType
The type of shared portfolios to accept. The default is to accept imported portfolios.
AWS_ORGANIZATIONS - Accept portfolios shared by the management account of your organization.
IMPORTED - Accept imported portfolios.
AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)
For example,
aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS
String key
The access level.
Account - Filter results based on the account.
Role - Filter results based on the federated role of the specified user.
User - Filter results based on the specified user.
String value
The user to which the access level applies. The only supported value is Self.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String principalARN
The ARN of the principal (IAM user, role, or group).
String principalType
The principal type. The supported value is IAM.
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String budgetName
Name of the associated budget.
String name
The name of the CloudWatch dashboard.
String constraintId
The identifier of the constraint.
String type
The type of constraint.
LAUNCH
NOTIFICATION
STACKSET
TEMPLATE
String description
The description of the constraint.
String owner
The owner of the constraint.
String productId
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.
String portfolioId
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String sourceProductArn
The Amazon Resource Name (ARN) of the source product.
String targetProductId
The identifier of the target product. By default, a new product is created.
String targetProductName
A name for the target product. The default is the name of the source product.
List<E> sourceProvisioningArtifactIdentifiers
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.
List<E> copyOptions
The copy options. If the value is CopyTags, the tags from the source product are copied to the
target product.
String idempotencyToken
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.
String copyProductToken
The token to use to track the progress of the operation.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String productId
The product identifier.
String parameters
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
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.
Specify the NotificationArns property as follows:
{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or
NOT_ALLOWED.
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.
Specify the Rules property. For more information, see Template Constraint Rules.
String type
The type of constraint.
LAUNCH
NOTIFICATION
RESOURCE_UPDATE
STACKSET
TEMPLATE
String description
The description of the constraint.
String idempotencyToken
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.
ConstraintDetail constraintDetail
Information about the constraint.
String constraintParameters
The constraint parameters.
String status
The status of the current request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String displayName
The name to use for display purposes.
String description
The description of the portfolio.
String providerName
The name of the portfolio provider.
List<E> tags
One or more tags.
String idempotencyToken
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.
PortfolioDetail portfolioDetail
Information about the portfolio.
List<E> tags
Information about the tags associated with the portfolio.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String accountId
The AWS account ID. For example, 123456789012.
OrganizationNode organizationNode
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.
Boolean shareTagOptions
Enables or disables TagOptions sharing when creating the portfolio share. If this flag is not
provided, TagOptions sharing is disabled.
String portfolioShareToken
The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String name
The name of the product.
String owner
The owner of the product.
String description
The description of the product.
String distributor
The distributor of the product.
String supportDescription
The support information about the product.
String supportEmail
The contact email for product support.
String supportUrl
The contact URL for product support.
^https?:\/\// / is the pattern used to validate SupportUrl.
String productType
The type of product.
List<E> tags
One or more tags.
ProvisioningArtifactProperties provisioningArtifactParameters
The configuration of the provisioning artifact.
String idempotencyToken
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.
ProductViewDetail productViewDetail
Information about the product view.
ProvisioningArtifactDetail provisioningArtifactDetail
Information about the provisioning artifact.
List<E> tags
Information about the tags associated with the product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String planName
The name of the plan.
String planType
The plan type.
List<E> notificationArns
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
String pathId
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.
String productId
The product identifier.
String provisionedProductName
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.
String provisioningArtifactId
The identifier of the provisioning artifact.
List<E> provisioningParameters
Parameters specified by the administrator that are required for provisioning the product.
String idempotencyToken
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.
List<E> tags
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.
String planName
The name of the plan.
String planId
The plan identifier.
String provisionProductId
The product identifier.
String provisionedProductName
The user-friendly name of the provisioned product.
String provisioningArtifactId
The identifier of the provisioning artifact.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier.
ProvisioningArtifactProperties parameters
The configuration for the provisioning artifact.
String idempotencyToken
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.
ProvisioningArtifactDetail provisioningArtifactDetail
Information about the provisioning artifact.
Map<K,V> info
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.
String status
The status of the current request.
String name
The self-service action name.
String definitionType
The service action definition type. For example, SSM_AUTOMATION.
Map<K,V> definition
The self-service action definition. Can be one of the following:
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.
The AWS Systems Manager automation document version. For example, "Version": "1"
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".
The list of parameters in JSON format.
For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or
[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
String description
The self-service action description.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String idempotencyToken
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.
ServiceActionDetail serviceActionDetail
An object containing information about the self-service action.
TagOptionDetail tagOptionDetail
Information about the TagOption.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String accountId
The AWS account ID.
OrganizationNode organizationNode
The organization node to whom you are going to stop sharing.
String portfolioShareToken
The portfolio share unique identifier. This will only be returned if delete is made to an organization node.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String planId
The plan identifier.
Boolean ignoreErrors
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
String id
The TagOption identifier.
ConstraintDetail constraintDetail
Information about the constraint.
String constraintParameters
The constraint parameters.
String status
The status of the current request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String copyProductToken
The token for the copy product operation. This token is returned by CopyProduct.
PortfolioDetail portfolioDetail
Information about the portfolio.
List<E> tags
Information about the tags associated with the portfolio.
List<E> tagOptions
Information about the TagOptions associated with the portfolio.
List<E> budgets
Information about the associated budgets.
String portfolioId
The unique identifier of the portfolio for which shares will be retrieved.
String type
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.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String portfolioShareToken
The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.
String portfolioShareToken
The token for the portfolio share operation. For example, share-6v24abcdefghi.
String portfolioId
The portfolio identifier.
String organizationNodeValue
Organization node identifier. It can be either account id, organizational unit id or organization id.
String status
Status of the portfolio share operation.
ShareDetails shareDetails
Information about the portfolio share operation.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
The product identifier.
String name
The product name.
String sourcePortfolioId
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.
ProductViewDetail productViewDetail
Information about the product view.
List<E> provisioningArtifactSummaries
Information about the provisioning artifacts (also known as versions) for the specified product.
List<E> tags
Information about the tags associated with the product.
List<E> tagOptions
Information about the TagOptions associated with the product.
List<E> budgets
Information about the associated budgets.
ProductViewSummary productViewSummary
Summary information about the product view.
List<E> provisioningArtifacts
Information about the provisioning artifacts for the specified product.
List<E> budgets
Information about the associated budgets.
List<E> launchPaths
Information about the associated launch paths.
ProductViewSummary productViewSummary
Summary information about the product.
List<E> provisioningArtifacts
Information about the provisioning artifacts for the product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String planId
The plan identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
ProvisionedProductPlanDetails provisionedProductPlanDetails
Information about the plan.
List<E> resourceChanges
Information about the resource changes that will occur when the plan is executed.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
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.
String name
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.
ProvisionedProductDetail provisionedProductDetail
Information about the provisioned product.
List<E> cloudWatchDashboards
Any CloudWatch dashboards that were created when provisioning the product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisioningArtifactId
The identifier of the provisioning artifact.
String productId
The product identifier.
String provisioningArtifactName
The provisioning artifact name.
String productName
The product name.
Boolean verbose
Indicates whether a verbose level of detail is enabled.
ProvisioningArtifactDetail provisioningArtifactDetail
Information about the provisioning artifact.
Map<K,V> info
The URL of the CloudFormation template in Amazon S3.
String status
The status of the current request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier. You must provide the product name or ID, but not both.
String productName
The name of the product. You must provide the name or ID, but not both.
String provisioningArtifactId
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
String provisioningArtifactName
The name of the provisioning artifact. You must provide the name or ID, but not both.
String pathId
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.
String pathName
The name of the path. You must provide the name or ID, but not both.
List<E> provisioningArtifactParameters
Information about the parameters used to provision the product.
List<E> constraintSummaries
Information about the constraints used to provision the product.
List<E> usageInstructions
Any additional metadata specifically related to the provisioning of the product. For example, see the
Version field of the CloudFormation template.
List<E> tagOptions
Information about the TagOptions associated with the resource.
ProvisioningArtifactPreferences provisioningArtifactPreferences
An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.
List<E> provisioningArtifactOutputs
The output of the provisioning artifact.
List<E> provisioningArtifactOutputKeys
A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
The record identifier of the provisioned product. This identifier is returned by the request operation.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
RecordDetail recordDetail
Information about the product.
List<E> recordOutputs
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.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
ServiceActionDetail serviceActionDetail
Detailed information about the self-service action.
String id
The TagOption identifier.
TagOptionDetail tagOptionDetail
Information about the TagOption.
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String planId
The plan identifier.
String idempotencyToken
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.
RecordDetail recordDetail
Information about the result of provisioning the product.
String provisionedProductId
The identifier of the provisioned product.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
String executeToken
An idempotency token that uniquely identifies the execute request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
Map<K,V> parameters
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.
RecordDetail recordDetail
An object containing detailed information about the result of provisioning the product.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
String errorCode
The error code. Valid values are listed below.
String errorMessage
A text description of the error.
String accessStatus
The status of the portfolio share feature.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisionedProductId
The identifier of the provisioned product that you want the outputs from.
String provisionedProductName
The name of the provisioned product that you want the outputs from.
List<E> outputKeys
The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
List<E> outputs
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.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier.
String provisioningArtifactId
The identifier of the provisioning artifact.
String provisionedProductName
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.
String physicalId
The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.
String idempotencyToken
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.
RecordDetail recordDetail
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String portfolioShareType
The type of shared portfolios to list. The default is to list imported portfolios.
AWS_ORGANIZATIONS - List portfolios accepted and shared via organizational sharing by the management
account or delegated administrator of your organization.
AWS_SERVICECATALOG - Deprecated type.
IMPORTED - List imported portfolios that have been accepted and shared through account-to-account
sharing.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String resourceId
The resource identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String productId
The product identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier. For example, port-2abcdext3y5fk.
String organizationNodeType
The organization node type that will be returned in the output.
ORGANIZATION - Organization that has access to the portfolio.
ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.
ACCOUNT - Account that has access to the portfolio within your organization.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String organizationParentId
The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisionProductId
The product identifier.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
AccessLevelFilter accessLevelFilter
The access level to use to obtain results. The default is User.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
AccessLevelFilter accessLevelFilter
The access level to use to obtain results. The default is User.
ListRecordHistorySearchFilter searchFilter
The search filter to scope the results.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String tagOptionId
The TagOption identifier.
String resourceType
The resource type.
Portfolio
Product
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
List<E> serviceActionSummaries
An object containing information about the self-service actions associated with the provisioning artifact.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
List<E> serviceActionSummaries
An object containing information about the service actions associated with the provisioning artifact.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisionedProductId
The identifier of the provisioned product.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
ListTagOptionsFilters filters
The search filters. If no search filters are specified, the output includes all TagOptions.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
List<E> allowedValues
The values that the administrator has allowed for the parameter.
String allowedPattern
A regular expression that represents the patterns that allow for String types. The pattern must
match the entire parameter value provided.
String constraintDescription
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.
String maxLength
An integer value that determines the largest number of characters you want to allow for String
types.
String minLength
An integer value that determines the smallest number of characters you want to allow for String
types.
String maxValue
A numeric value that determines the largest numeric value you want to allow for Number types.
String minValue
A numeric value that determines the smallest numeric value you want to allow for Number types.
String id
The portfolio identifier.
String aRN
The ARN assigned to the portfolio.
String displayName
The name to use for display purposes.
String description
The description of the portfolio.
Date createdTime
The UTC time stamp of the creation time.
String providerName
The name of the portfolio provider.
String principalId
The identifier of the recipient entity that received the portfolio share. The recipient entities can be one of the following:
1. An external account.
2. An organziation member account.
3. An organzational unit (OU).
4. The organization itself. (This shares with every account in the organization).
String type
The type of the portfolio share.
Boolean accepted
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.
Boolean shareTagOptions
Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
ProductViewSummary productViewSummary
Summary information about the product view.
String status
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.
String productARN
The ARN of the product.
Date createdTime
The UTC time stamp of the creation time.
String id
The product view identifier.
String productId
The product identifier.
String name
The name of the product.
String owner
The owner of the product. Contact the product administrator for the significance of this value.
String shortDescription
Short description of the product.
String type
The product type. Contact the product administrator for the significance of this value. If this value is
MARKETPLACE, the product was created by AWS Marketplace.
String distributor
The distributor of the product. Contact the product administrator for the significance of this value.
Boolean hasDefaultPath
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.
String supportEmail
The email contact information to obtain support for this Product.
String supportDescription
The description of the support for this Product.
String supportUrl
The URL information to obtain support for this Product.
String name
The user-friendly name of the provisioned product.
String arn
The ARN of the provisioned product.
String type
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
String id
The identifier of the provisioned product.
String status
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.
String statusMessage
The current status message of the provisioned product.
Date createdTime
The UTC time stamp of the creation time.
String idempotencyToken
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.
String lastRecordId
The record identifier of the last request performed on this provisioned product.
String lastProvisioningRecordId
The record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
String lastSuccessfulProvisioningRecordId
The record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
List<E> tags
One or more tags.
String physicalId
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
String productId
The product identifier.
String productName
The name of the product.
String provisioningArtifactId
The identifier of the provisioning artifact.
String provisioningArtifactName
The name of the provisioning artifact.
String userArn
The Amazon Resource Name (ARN) of the IAM user.
String userArnSession
The ARN of the IAM user in the session. This ARN might contain a session ID.
String name
The user-friendly name of the provisioned product.
String arn
The ARN of the provisioned product.
String type
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
String id
The identifier of the provisioned product.
String status
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.
String statusMessage
The current status message of the provisioned product.
Date createdTime
The UTC time stamp of the creation time.
String idempotencyToken
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.
String lastRecordId
The record identifier of the last request performed on this provisioned product.
String lastProvisioningRecordId
The record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
String lastSuccessfulProvisioningRecordId
The record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
String launchRoleArn
The ARN of the launch role associated with the provisioned product.
Date createdTime
The UTC time stamp of the creation time.
String pathId
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.
String productId
The product identifier.
String planName
The name of the plan.
String planId
The plan identifier.
String provisionProductId
The product identifier.
String provisionProductName
The user-friendly name of the provisioned product.
String planType
The plan type.
String provisioningArtifactId
The identifier of the provisioning artifact.
String status
The status.
Date updatedTime
The time when the plan was last updated.
List<E> notificationArns
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
List<E> provisioningParameters
Parameters specified by the administrator that are required for provisioning the product.
List<E> tags
One or more tags.
String statusMessage
The status message.
String planName
The name of the plan.
String planId
The plan identifier.
String provisionProductId
The product identifier.
String provisionProductName
The user-friendly name of the provisioned product.
String planType
The plan type.
String provisioningArtifactId
The identifier of the provisioning artifact.
String id
The identifier of the provisioning artifact.
String name
The name of the provisioning artifact.
String description
The description of the provisioning artifact.
Date createdTime
The UTC time stamp of the creation time.
String guidance
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
String id
The identifier of the provisioning artifact.
String name
The name of the provisioning artifact.
String description
The description of the provisioning artifact.
String type
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
MARKETPLACE_AMI - AWS Marketplace AMI
MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources
Date createdTime
The UTC time stamp of the creation time.
Boolean active
Indicates whether the product version is active.
String guidance
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
String parameterKey
The parameter key.
String defaultValue
The default value.
String parameterType
The parameter type.
Boolean isNoEcho
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.
String description
The description of the parameter.
ParameterConstraints parameterConstraints
Constraints that the administrator has put on a parameter.
List<E> stackSetAccounts
One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in
ProvisioningPreferences$StackSetAccounts and
UpdateProvisioningPreferences$StackSetAccounts.
Applicable only to a CFN_STACKSET provisioned product type.
List<E> stackSetRegions
One or more AWS Regions where stack instances are deployed from the stack set. These regions can be scoped in
ProvisioningPreferences$StackSetRegions and
UpdateProvisioningPreferences$StackSetRegions.
Applicable only to a CFN_STACKSET provisioned product type.
String name
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
String description
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Map<K,V> info
Specify the template source with one of the following options, but not both. Keys accepted: [
LoadTemplateFromURL, ImportFromPhysicalId ]
The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only
supports CloudFormation stack arn. Specify the physical id in JSON format as follows:
ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
String type
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template
MARKETPLACE_AMI - AWS Marketplace AMI
MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources
Boolean disableTemplateValidation
If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
String id
The identifier of the provisioning artifact.
String name
The name of the provisioning artifact.
String description
The description of the provisioning artifact.
Date createdTime
The UTC time stamp of the creation time.
Map<K,V> provisioningArtifactMetadata
The metadata for the provisioning artifact. This is used with AWS Marketplace products.
ProductViewSummary productViewSummary
Summary information about a product view.
ProvisioningArtifact provisioningArtifact
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
List<E> stackSetAccounts
One or more AWS accounts where the provisioned product will be available.
Applicable only to a CFN_STACKSET provisioned product type.
The specified accounts should be within the list of accounts from the STACKSET constraint. To get
the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all acounts from the STACKSET constraint.
List<E> stackSetRegions
One or more AWS Regions where the provisioned product will be available.
Applicable only to a CFN_STACKSET provisioned product type.
The specified regions should be within the list of regions from the STACKSET constraint. To get the
list of regions in the STACKSET constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all regions from the STACKSET constraint.
Integer stackSetFailureToleranceCount
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or
StackSetFailureTolerancePercentage, but not both.
The default value is 0 if no value is specified.
Integer stackSetFailureTolerancePercentage
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or
StackSetFailureTolerancePercentage, but not both.
Integer stackSetMaxConcurrencyCount
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the
StackSetFailureToleranceCount.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or
StackSetMaxConcurrentPercentage, but not both.
Integer stackSetMaxConcurrencyPercentage
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the
next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS
Service Catalog sets the number as 1 instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or
StackSetMaxConcurrentPercentage, but not both.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier. You must provide the name or ID, but not both.
String productName
The name of the product. You must provide the name or ID, but not both.
String provisioningArtifactId
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
String provisioningArtifactName
The name of the provisioning artifact. You must provide the name or ID, but not both.
String pathId
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.
String pathName
The name of the path. You must provide the name or ID, but not both.
String provisionedProductName
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.
List<E> provisioningParameters
Parameters specified by the administrator that are required for provisioning the product.
ProvisioningPreferences provisioningPreferences
An object that contains information about the provisioning preferences for a stack set.
List<E> tags
One or more tags.
List<E> notificationArns
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
String provisionToken
An idempotency token that uniquely identifies the provisioning request.
RecordDetail recordDetail
Information about the result of provisioning the product.
String recordId
The identifier of the record.
String provisionedProductName
The user-friendly name of the provisioned product.
String status
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed
and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages
returned.
Date createdTime
The UTC time stamp of the creation time.
Date updatedTime
The time when the record was last updated.
String provisionedProductType
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.
String recordType
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
String provisionedProductId
The identifier of the provisioned product.
String productId
The product identifier.
String provisioningArtifactId
The identifier of the provisioning artifact.
String pathId
The path identifier.
List<E> recordErrors
The errors that occurred.
List<E> recordTags
One or more tags.
String launchRoleArn
The ARN of the launch role associated with the provisioned product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
String portfolioShareType
The type of shared portfolios to reject. The default is to reject imported portfolios.
AWS_ORGANIZATIONS - Reject portfolios shared by the management account of your organization.
IMPORTED - Reject imported portfolios.
AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)
For example,
aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS
String action
The change action.
String logicalResourceId
The ID of the resource, as defined in the CloudFormation template.
String physicalResourceId
The ID of the resource, if it was already created.
String resourceType
The type of resource.
String replacement
If the change type is Modify, indicates whether the existing resource is deleted and replaced with a
new one.
List<E> scope
The change scope.
List<E> details
Information about the resource changes.
ResourceTargetDefinition target
Information about the resource attribute to be modified.
String evaluation
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.
String causingEntity
The ID of the entity that caused the change.
String attribute
The attribute to be changed.
String name
If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.
String requiresRecreation
If the attribute is Properties, indicates whether a change to this property causes the resource to
be re-created.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
AccessLevelFilter accessLevelFilter
The access level to use to obtain results. The default is User.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The portfolio identifier.
Map<K,V> filters
The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
String sortBy
The sort field. If no value is specified, the results are not sorted.
String sortOrder
The sort order. If no value is specified, the results are not sorted.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
Integer pageSize
The maximum number of items to return with this call.
String productSource
Access level of the source of the product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
Map<K,V> filters
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
Integer pageSize
The maximum number of items to return with this call.
String sortBy
The sort field. If no value is specified, the results are not sorted.
String sortOrder
The sort order. If no value is specified, the results are not sorted.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
List<E> productViewSummaries
Information about the product views.
Map<K,V> productViewAggregations
The product view aggregations.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
AccessLevelFilter accessLevelFilter
The access level to use to obtain results. The default is User.
Map<K,V> filters
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"]
String sortBy
The sort field. If no value is specified, the results are not sorted. The valid values are arn,
id, name, and lastRecordId.
String sortOrder
The sort order. If no value is specified, the results are not sorted.
Integer pageSize
The maximum number of items to return with this call.
String pageToken
The page token for the next set of results. To retrieve the first set of results, use null.
List<E> provisionedProducts
Information about the provisioned products.
Integer totalResultsCount
The number of provisioned products found.
String nextPageToken
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
String serviceActionId
The self-service action identifier. For example, act-fs7abcd89wxyz.
String productId
The product identifier. For example, prod-abcdzk7xy33qa.
String provisioningArtifactId
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.
ServiceActionSummary serviceActionSummary
Summary information about the self-service action.
Map<K,V> definition
A map that defines the self-service action.
String account
The name of the AWS account that the stack instance is associated with.
String region
The name of the AWS region that the stack instance is associated with.
String stackInstanceStatus
The status of the stack instance, in terms of its synchronization with its associated stack set.
INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
need to perform a DeleteStackInstances operation, with RetainStacks set to true, to
delete the stack instance, and then delete the stack manually.
OUTDATED: The stack isn't currently up to date with the stack set because either the associated
stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part
of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the
stack was created or updated.
CURRENT: The stack is currently up to date with the stack set.
String provisionedProductName
The name of the provisioned product. You cannot specify both ProvisionedProductName and
ProvisionedProductId.
String provisionedProductId
The identifier of the provisioned product. You cannot specify both ProvisionedProductName and
ProvisionedProductId.
String terminateToken
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.
Boolean ignoreErrors
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
Boolean retainPhysicalResources
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.
RecordDetail recordDetail
Information about the result of this request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
The identifier of the constraint.
String description
The updated description of the constraint.
String parameters
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
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.
Specify the NotificationArns property as follows:
{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}
Specify the TagUpdatesOnProvisionedProduct property as follows:
{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}
The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or
NOT_ALLOWED.
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.
Specify the Rules property. For more information, see Template Constraint Rules.
ConstraintDetail constraintDetail
Information about the constraint.
String constraintParameters
The constraint parameters.
String status
The status of the current request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
The portfolio identifier.
String displayName
The name to use for display purposes.
String description
The updated description of the portfolio.
String providerName
The updated name of the portfolio provider.
List<E> addTags
The tags to add.
List<E> removeTags
The tags to remove.
PortfolioDetail portfolioDetail
Information about the portfolio.
List<E> tags
Information about the tags associated with the portfolio.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String portfolioId
The unique identifier of the portfolio for which the share will be updated.
String accountId
The AWS Account Id of the recipient account. This field is required when updating an external account to account type share.
OrganizationNode organizationNode
Boolean shareTagOptions
A flag to enable or disable TagOptions sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.
String portfolioShareToken
The token that tracks the status of the UpdatePortfolioShare operation for external account to
account or organizational type sharing.
String status
The status of UpdatePortfolioShare operation. You can also obtain the operation status using
DescribePortfolioShareStatus API.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String id
The product identifier.
String name
The updated product name.
String owner
The updated owner of the product.
String description
The updated description of the product.
String distributor
The updated distributor of the product.
String supportDescription
The updated support description for the product.
String supportEmail
The updated support email for the product.
String supportUrl
The updated support URL for the product.
List<E> addTags
The tags to add to the product.
List<E> removeTags
The tags to remove from the product.
ProductViewDetail productViewDetail
Information about the product view.
List<E> tags
Information about the tags associated with the product.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisionedProductId
The identifier of the provisioned product.
Map<K,V> provisionedProductProperties
A map that contains the provisioned product properties to be updated.
The LAUNCH_ROLE key accepts role ARNs. This key allows an administrator to call
UpdateProvisionedProductProperties to update the launch role that is associated with a provisioned
product. This role is used when an end user calls a provisioning operation such as
UpdateProvisionedProduct, TerminateProvisionedProduct, or
ExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.
The OWNER key accepts user ARNs and role ARNs. The owner is the user that has permission to see,
update, terminate, and execute service actions in the provisioned product.
The administrator can change the owner of a provisioned product to another IAM user within the same account. Both
end user owners and administrators can see ownership history of the provisioned product using the
ListRecordHistory API. The new owner can describe all past records for the provisioned product using
the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can
still see the product's history from when he was an owner using ListRecordHistory.
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.
String idempotencyToken
The idempotency token that uniquely identifies the provisioning product update request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String provisionedProductName
The name of the provisioned product. You cannot specify both ProvisionedProductName and
ProvisionedProductId.
String provisionedProductId
The identifier of the provisioned product. You must provide the name or ID, but not both.
String productId
The identifier of the product. You must provide the name or ID, but not both.
String productName
The name of the product. You must provide the name or ID, but not both.
String provisioningArtifactId
The identifier of the provisioning artifact.
String provisioningArtifactName
The name of the provisioning artifact. You must provide the name or ID, but not both.
String pathId
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.
String pathName
The name of the path. You must provide the name or ID, but not both.
List<E> provisioningParameters
The new parameters.
UpdateProvisioningPreferences provisioningPreferences
An object that contains information about the provisioning preferences for a stack set.
List<E> tags
One or more tags. Requires the product to have RESOURCE_UPDATE constraint with
TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
String updateToken
The idempotency token that uniquely identifies the provisioning update request.
RecordDetail recordDetail
Information about the result of the request.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
String productId
The product identifier.
String provisioningArtifactId
The identifier of the provisioning artifact.
String name
The updated name of the provisioning artifact.
String description
The updated description of the provisioning artifact.
Boolean active
Indicates whether the product version is active.
Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
String guidance
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
The DEFAULT value indicates that the product version is active.
The administrator can set the guidance to DEPRECATED to inform users that the product version is
deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new
provisioned products using a deprecated version.
ProvisioningArtifactDetail provisioningArtifactDetail
Information about the provisioning artifact.
Map<K,V> info
The URL of the CloudFormation template in Amazon S3.
String status
The status of the current request.
List<E> stackSetAccounts
One or more AWS accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get
the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the STACKSET constraint.
List<E> stackSetRegions
One or more AWS Regions where the provisioned product will be available.
Applicable only to a CFN_STACKSET provisioned product type.
The specified regions should be within the list of regions from the STACKSET constraint. To get the
list of regions in the STACKSET constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all regions from the STACKSET constraint.
Integer stackSetFailureToleranceCount
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or
StackSetFailureTolerancePercentage, but not both.
The default value is 0 if no value is specified.
Integer stackSetFailureTolerancePercentage
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or
StackSetFailureTolerancePercentage, but not both.
Integer stackSetMaxConcurrencyCount
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the
StackSetFailureToleranceCount.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or
StackSetMaxConcurrentPercentage, but not both.
Integer stackSetMaxConcurrencyPercentage
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the
next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS
Service Catalog sets the number as 1 instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or
StackSetMaxConcurrentPercentage, but not both.
String stackSetOperationType
Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the
provisioned product. The default value is UPDATE if nothing is specified.
Applicable only to a CFN_STACKSET provisioned product type.
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
Updates the stack set represented by the provisioned product and also its stack instances.
Deletes a stack instance in the stack set represented by the provisioned product.
String id
The self-service action identifier.
String name
The self-service action name.
Map<K,V> definition
A map that defines the self-service action.
String description
The self-service action description.
String acceptLanguage
The language code.
en - English (default)
jp - Japanese
zh - Chinese
ServiceActionDetail serviceActionDetail
Detailed information about the self-service action.
TagOptionDetail tagOptionDetail
Information about the TagOption.
Copyright © 2022. All rights reserved.