AWS Service Catalog 2015-12-10
- Client: Aws\ServiceCatalog\ServiceCatalogClient
- Service ID: servicecatalog
- Version: 2015-12-10
This page describes the parameters and results for the operations of the AWS Service Catalog (2015-12-10), and shows how to use the Aws\ServiceCatalog\ServiceCatalogClient object to call the described operations. This documentation is specific to the 2015-12-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcceptPortfolioShare ( array $params = [] )
Accepts an offer to share the specified portfolio.
- AssociateBudgetWithResource ( array $params = [] )
Associates the specified budget with the specified resource.
- AssociatePrincipalWithPortfolio ( array $params = [] )
Associates the specified principal ARN with the specified portfolio.
- AssociateProductWithPortfolio ( array $params = [] )
Associates the specified product with the specified portfolio.
- AssociateServiceActionWithProvisioningArtifact ( array $params = [] )
Associates a self-service action with a provisioning artifact.
- AssociateTagOptionWithResource ( array $params = [] )
Associate the specified TagOption with the specified portfolio or product.
- BatchAssociateServiceActionWithProvisioningArtifact ( array $params = [] )
Associates multiple self-service actions with provisioning artifacts.
- BatchDisassociateServiceActionFromProvisioningArtifact ( array $params = [] )
Disassociates a batch of self-service actions from the specified provisioning artifact.
- CopyProduct ( array $params = [] )
Copies the specified source product to the specified target product or a new product.
- CreateConstraint ( array $params = [] )
Creates a constraint.
- CreatePortfolio ( array $params = [] )
Creates a portfolio.
- CreatePortfolioShare ( array $params = [] )
Shares the specified portfolio with the specified account or organization node.
- CreateProduct ( array $params = [] )
Creates a product.
- CreateProvisionedProductPlan ( array $params = [] )
Creates a plan.
- CreateProvisioningArtifact ( array $params = [] )
Creates a provisioning artifact (also known as a version) for the specified product.
- CreateServiceAction ( array $params = [] )
Creates a self-service action.
- CreateTagOption ( array $params = [] )
Creates a TagOption.
- DeleteConstraint ( array $params = [] )
Deletes the specified constraint.
- DeletePortfolio ( array $params = [] )
Deletes the specified portfolio.
- DeletePortfolioShare ( array $params = [] )
Stops sharing the specified portfolio with the specified account or organization node.
- DeleteProduct ( array $params = [] )
Deletes the specified product.
- DeleteProvisionedProductPlan ( array $params = [] )
Deletes the specified plan.
- DeleteProvisioningArtifact ( array $params = [] )
Deletes the specified provisioning artifact (also known as a version) for the specified product.
- DeleteServiceAction ( array $params = [] )
Deletes a self-service action.
- DeleteTagOption ( array $params = [] )
Deletes the specified TagOption.
- DescribeConstraint ( array $params = [] )
Gets information about the specified constraint.
- DescribeCopyProductStatus ( array $params = [] )
Gets the status of the specified copy product operation.
- DescribePortfolio ( array $params = [] )
Gets information about the specified portfolio.
- DescribePortfolioShareStatus ( array $params = [] )
Gets the status of the specified portfolio share operation.
- DescribePortfolioShares ( array $params = [] )
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
- DescribeProduct ( array $params = [] )
Gets information about the specified product.
- DescribeProductAsAdmin ( array $params = [] )
Gets information about the specified product.
- DescribeProductView ( array $params = [] )
Gets information about the specified product.
- DescribeProvisionedProduct ( array $params = [] )
Gets information about the specified provisioned product.
- DescribeProvisionedProductPlan ( array $params = [] )
Gets information about the resource changes for the specified plan.
- DescribeProvisioningArtifact ( array $params = [] )
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
- DescribeProvisioningParameters ( array $params = [] )
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
- DescribeRecord ( array $params = [] )
Gets information about the specified request operation.
- DescribeServiceAction ( array $params = [] )
Describes a self-service action.
- DescribeServiceActionExecutionParameters ( array $params = [] )
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
- DescribeTagOption ( array $params = [] )
Gets information about the specified TagOption.
- DisableAWSOrganizationsAccess ( array $params = [] )
Disable portfolio sharing through the Organizations service.
- DisassociateBudgetFromResource ( array $params = [] )
Disassociates the specified budget from the specified resource.
- DisassociatePrincipalFromPortfolio ( array $params = [] )
Disassociates a previously associated principal ARN from a specified portfolio.
- DisassociateProductFromPortfolio ( array $params = [] )
Disassociates the specified product from the specified portfolio.
- DisassociateServiceActionFromProvisioningArtifact ( array $params = [] )
Disassociates the specified self-service action association from the specified provisioning artifact.
- DisassociateTagOptionFromResource ( array $params = [] )
Disassociates the specified TagOption from the specified resource.
- EnableAWSOrganizationsAccess ( array $params = [] )
Enable portfolio sharing feature through Organizations.
- ExecuteProvisionedProductPlan ( array $params = [] )
Provisions or modifies a product based on the resource changes for the specified plan.
- ExecuteProvisionedProductServiceAction ( array $params = [] )
Executes a self-service action against a provisioned product.
- GetAWSOrganizationsAccessStatus ( array $params = [] )
Get the Access Status for Organizations portfolio share feature.
- GetProvisionedProductOutputs ( array $params = [] )
This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
- ImportAsProvisionedProduct ( array $params = [] )
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.
- ListAcceptedPortfolioShares ( array $params = [] )
Lists all imported portfolios for which account-to-account shares were accepted by this account.
- ListBudgetsForResource ( array $params = [] )
Lists all the budgets associated to the specified resource.
- ListConstraintsForPortfolio ( array $params = [] )
Lists the constraints for the specified portfolio and product.
- ListLaunchPaths ( array $params = [] )
Lists the paths to the specified product.
- ListOrganizationPortfolioAccess ( array $params = [] )
Lists the organization nodes that have access to the specified portfolio.
- ListPortfolioAccess ( array $params = [] )
Lists the account IDs that have access to the specified portfolio.
- ListPortfolios ( array $params = [] )
Lists all portfolios in the catalog.
- ListPortfoliosForProduct ( array $params = [] )
Lists all portfolios that the specified product is associated with.
- ListPrincipalsForPortfolio ( array $params = [] )
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.
- ListProvisionedProductPlans ( array $params = [] )
Lists the plans for the specified provisioned product or all plans to which the user has access.
- ListProvisioningArtifacts ( array $params = [] )
Lists all provisioning artifacts (also known as versions) for the specified product.
- ListProvisioningArtifactsForServiceAction ( array $params = [] )
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
- ListRecordHistory ( array $params = [] )
Lists the specified requests or all performed requests.
- ListResourcesForTagOption ( array $params = [] )
Lists the resources associated with the specified TagOption.
- ListServiceActions ( array $params = [] )
Lists all self-service actions.
- ListServiceActionsForProvisioningArtifact ( array $params = [] )
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
- ListStackInstancesForProvisionedProduct ( array $params = [] )
Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product.
- ListTagOptions ( array $params = [] )
Lists the specified TagOptions or all TagOptions.
- ProvisionProduct ( array $params = [] )
Provisions the specified product.
- RejectPortfolioShare ( array $params = [] )
Rejects an offer to share the specified portfolio.
- ScanProvisionedProducts ( array $params = [] )
Lists the provisioned products that are available (not terminated).
- SearchProducts ( array $params = [] )
Gets information about the products to which the caller has access.
- SearchProductsAsAdmin ( array $params = [] )
Gets information about the products for the specified portfolio or all products.
- SearchProvisionedProducts ( array $params = [] )
Gets information about the provisioned products that meet the specified criteria.
- TerminateProvisionedProduct ( array $params = [] )
Terminates the specified provisioned product.
- UpdateConstraint ( array $params = [] )
Updates the specified constraint.
- UpdatePortfolio ( array $params = [] )
Updates the specified portfolio.
- UpdatePortfolioShare ( array $params = [] )
Updates the specified portfolio share.
- UpdateProduct ( array $params = [] )
Updates the specified product.
- UpdateProvisionedProduct ( array $params = [] )
Requests updates to the configuration of the specified provisioned product.
- UpdateProvisionedProductProperties ( array $params = [] )
Requests updates to the properties of the specified provisioned product.
- UpdateProvisioningArtifact ( array $params = [] )
Updates the specified provisioning artifact (also known as a version) for the specified product.
- UpdateServiceAction ( array $params = [] )
Updates a self-service action.
- UpdateTagOption ( array $params = [] )
Updates the specified TagOption.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribePortfolioShares
- GetProvisionedProductOutputs
- ListAcceptedPortfolioShares
- ListBudgetsForResource
- ListConstraintsForPortfolio
- ListLaunchPaths
- ListOrganizationPortfolioAccess
- ListPortfolioAccess
- ListPortfolios
- ListPortfoliosForProduct
- ListPrincipalsForPortfolio
- ListProvisioningArtifactsForServiceAction
- ListResourcesForTagOption
- ListServiceActions
- ListServiceActionsForProvisioningArtifact
- ListTagOptions
- SearchProducts
- SearchProductsAsAdmin
- SearchProvisionedProducts
Operations
AcceptPortfolioShare
$result = $client->acceptPortfolioShare([/* ... */]); $promise = $client->acceptPortfolioShareAsync([/* ... */]);
Accepts an offer to share the specified portfolio.
Parameter Syntax
$result = $client->acceptPortfolioShare([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'PortfolioShareType' => 'IMPORTED|AWS_SERVICECATALOG|AWS_ORGANIZATIONS',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- PortfolioShareType
-
- Type: string
The type of shared portfolios to accept. The default is to accept imported portfolios.
-
AWS_ORGANIZATIONS- Accept portfolios shared by the management account of your organization. -
IMPORTED- Accept imported portfolios. -
AWS_SERVICECATALOG- Not supported. (Throws ResourceNotFoundException.)
For example,
aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
AssociateBudgetWithResource
$result = $client->associateBudgetWithResource([/* ... */]); $promise = $client->associateBudgetWithResourceAsync([/* ... */]);
Associates the specified budget with the specified resource.
Parameter Syntax
$result = $client->associateBudgetWithResource([
'BudgetName' => '<string>', // REQUIRED
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource is a duplicate.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
The specified resource was not found.
AssociatePrincipalWithPortfolio
$result = $client->associatePrincipalWithPortfolio([/* ... */]); $promise = $client->associatePrincipalWithPortfolioAsync([/* ... */]);
Associates the specified principal ARN with the specified portfolio.
If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share.
The PortfolioID, PrincipalARN, and PrincipalType parameters are required.
You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
Parameter Syntax
$result = $client->associatePrincipalWithPortfolio([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'PrincipalARN' => '<string>', // REQUIRED
'PrincipalType' => 'IAM|IAM_PATTERN', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- PrincipalARN
-
- Required: Yes
- Type: string
The ARN of the principal (IAM user, role, or group). This field allows an ARN with no
accountIDifPrincipalTypeisIAM_PATTERN.You can associate multiple
IAMpatterns even if the account has no principal with that name. This is useful in Principal Name Sharing if you want to share a principal without creating it in the account that owns the portfolio. - PrincipalType
-
- Required: Yes
- Type: string
The principal type. The supported value is
IAMif you use a fully defined ARN, orIAM_PATTERNif you use an ARN with noaccountID.
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
AssociateProductWithPortfolio
$result = $client->associateProductWithPortfolio([/* ... */]); $promise = $client->associateProductWithPortfolioAsync([/* ... */]);
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->associateProductWithPortfolio([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'ProductId' => '<string>', // REQUIRED
'SourcePortfolioId' => '<string>',
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
AssociateServiceActionWithProvisioningArtifact
$result = $client->associateServiceActionWithProvisioningArtifact([/* ... */]); $promise = $client->associateServiceActionWithProvisioningArtifactAsync([/* ... */]);
Associates a self-service action with a provisioning artifact.
Parameter Syntax
$result = $client->associateServiceActionWithProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ProductId
-
- Required: Yes
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne. - ServiceActionId
-
- Required: Yes
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
The specified resource is a duplicate.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
AssociateTagOptionWithResource
$result = $client->associateTagOptionWithResource([/* ... */]); $promise = $client->associateTagOptionWithResourceAsync([/* ... */]);
Associate the specified TagOption with the specified portfolio or product.
Parameter Syntax
$result = $client->associateTagOptionWithResource([
'ResourceId' => '<string>', // REQUIRED
'TagOptionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
The specified resource is a duplicate.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
BatchAssociateServiceActionWithProvisioningArtifact
$result = $client->batchAssociateServiceActionWithProvisioningArtifact([/* ... */]); $promise = $client->batchAssociateServiceActionWithProvisioningArtifactAsync([/* ... */]);
Associates multiple self-service actions with provisioning artifacts.
Parameter Syntax
$result = $client->batchAssociateServiceActionWithProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ServiceActionAssociations' => [ // REQUIRED
[
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ServiceActionAssociations
-
- Required: Yes
- Type: Array of ServiceActionAssociation structures
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
Result Syntax
[
'FailedServiceActionAssociations' => [
[
'ErrorCode' => 'DUPLICATE_RESOURCE|INTERNAL_FAILURE|LIMIT_EXCEEDED|RESOURCE_NOT_FOUND|THROTTLING',
'ErrorMessage' => '<string>',
'ProductId' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ServiceActionId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedServiceActionAssociations
-
- Type: Array of FailedServiceActionAssociation structures
An object that contains a list of errors, along with information to help you identify the self-service action.
Errors
-
One or more parameters provided to the operation are not valid.
BatchDisassociateServiceActionFromProvisioningArtifact
$result = $client->batchDisassociateServiceActionFromProvisioningArtifact([/* ... */]); $promise = $client->batchDisassociateServiceActionFromProvisioningArtifactAsync([/* ... */]);
Disassociates a batch of self-service actions from the specified provisioning artifact.
Parameter Syntax
$result = $client->batchDisassociateServiceActionFromProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ServiceActionAssociations' => [ // REQUIRED
[
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ServiceActionAssociations
-
- Required: Yes
- Type: Array of ServiceActionAssociation structures
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
Result Syntax
[
'FailedServiceActionAssociations' => [
[
'ErrorCode' => 'DUPLICATE_RESOURCE|INTERNAL_FAILURE|LIMIT_EXCEEDED|RESOURCE_NOT_FOUND|THROTTLING',
'ErrorMessage' => '<string>',
'ProductId' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ServiceActionId' => '<string>',
],
// ...
],
]
Result Details
Members
- FailedServiceActionAssociations
-
- Type: Array of FailedServiceActionAssociation structures
An object that contains a list of errors, along with information to help you identify the self-service action.
Errors
-
One or more parameters provided to the operation are not valid.
CopyProduct
$result = $client->copyProduct([/* ... */]); $promise = $client->copyProductAsync([/* ... */]);
Copies the specified source product to the specified target product or a new product.
You can copy a product to the same account or another account. You can copy a product to the same Region or another Region. If you copy a product to another account, you must first share the product in a portfolio using CreatePortfolioShare.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
Parameter Syntax
$result = $client->copyProduct([
'AcceptLanguage' => '<string>',
'CopyOptions' => ['<string>', ...],
'IdempotencyToken' => '<string>', // REQUIRED
'SourceProductArn' => '<string>', // REQUIRED
'SourceProvisioningArtifactIdentifiers' => [
['<string>', ...],
// ...
],
'TargetProductId' => '<string>',
'TargetProductName' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- CopyOptions
-
- Type: Array of strings
The copy options. If the value is
CopyTags, the tags from the source product are copied to the target product. - IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- SourceProductArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source product.
- SourceProvisioningArtifactIdentifiers
-
- Type: Array of stringss
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.
- TargetProductId
-
- Type: string
The identifier of the target product. By default, a new product is created.
- TargetProductName
-
- Type: string
A name for the target product. The default is the name of the source product.
Result Syntax
[
'CopyProductToken' => '<string>',
]
Result Details
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
CreateConstraint
$result = $client->createConstraint([/* ... */]); $promise = $client->createConstraintAsync([/* ... */]);
Creates a constraint.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->createConstraint([
'AcceptLanguage' => '<string>',
'Description' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'Parameters' => '<string>', // REQUIRED
'PortfolioId' => '<string>', // REQUIRED
'ProductId' => '<string>', // REQUIRED
'Type' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Description
-
- Type: string
The description of the constraint.
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- Parameters
-
- Required: Yes
- Type: string
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
- LAUNCH
-
You are required to specify either the
RoleArnor theLocalRoleNamebut can't use both.Specify the
RoleArnproperty as follows:{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}Specify the
LocalRoleNameproperty as follows:{"LocalRoleName": "SCBasicLaunchRole"}If you specify the
LocalRoleNameproperty, 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
LAUNCHand aSTACKSETconstraint.You also cannot have more than one
LAUNCHconstraint on a product and portfolio. - NOTIFICATION
-
Specify the
NotificationArnsproperty as follows:{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} - RESOURCE_UPDATE
-
Specify the
TagUpdatesOnProvisionedProductproperty as follows:{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}The
TagUpdatesOnProvisionedProductproperty accepts a string value ofALLOWEDorNOT_ALLOWED. - STACKSET
-
Specify the
Parametersproperty as follows:{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}You cannot have both a
LAUNCHand aSTACKSETconstraint.You also cannot have more than one
STACKSETconstraint on a product and portfolio.Products with a
STACKSETconstraint will launch an CloudFormation stack set. - TEMPLATE
-
Specify the
Rulesproperty. For more information, see Template Constraint Rules.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
- Type
-
- Required: Yes
- Type: string
The type of constraint.
-
LAUNCH -
NOTIFICATION -
RESOURCE_UPDATE -
STACKSET -
TEMPLATE
Result Syntax
[
'ConstraintDetail' => [
'ConstraintId' => '<string>',
'Description' => '<string>',
'Owner' => '<string>',
'PortfolioId' => '<string>',
'ProductId' => '<string>',
'Type' => '<string>',
],
'ConstraintParameters' => '<string>',
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- ConstraintDetail
-
- Type: ConstraintDetail structure
Information about the constraint.
- ConstraintParameters
-
- Type: string
The constraint parameters.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
The specified resource is a duplicate.
CreatePortfolio
$result = $client->createPortfolio([/* ... */]); $promise = $client->createPortfolioAsync([/* ... */]);
Creates a portfolio.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->createPortfolio([
'AcceptLanguage' => '<string>',
'Description' => '<string>',
'DisplayName' => '<string>', // REQUIRED
'IdempotencyToken' => '<string>', // REQUIRED
'ProviderName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Description
-
- Type: string
The description of the portfolio.
- DisplayName
-
- Required: Yes
- Type: string
The name to use for display purposes.
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- ProviderName
-
- Required: Yes
- Type: string
The name of the portfolio provider.
- Tags
-
- Type: Array of Tag structures
One or more tags.
Result Syntax
[
'PortfolioDetail' => [
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- PortfolioDetail
-
- Type: PortfolioDetail structure
Information about the portfolio.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the portfolio.
Errors
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
CreatePortfolioShare
$result = $client->createPortfolioShare([/* ... */]); $promise = $client->createPortfolioShareAsync([/* ... */]);
Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.
Note that if a delegated admin is de-registered, they can no longer create portfolio shares.
AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.
You can't share a shared resource, including portfolios that contain a shared product.
If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the UpdatePortfolioShare API instead.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
Parameter Syntax
$result = $client->createPortfolioShare([
'AcceptLanguage' => '<string>',
'AccountId' => '<string>',
'OrganizationNode' => [
'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
'Value' => '<string>',
],
'PortfolioId' => '<string>', // REQUIRED
'SharePrincipals' => true || false,
'ShareTagOptions' => true || false,
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccountId
-
- Type: string
The Amazon Web Services account ID. For example,
123456789012. - OrganizationNode
-
- Type: OrganizationNode structure
The organization node to whom you are going to share. When you pass
OrganizationNode, it createsPortfolioSharefor all of the Amazon Web Services accounts that are associated to theOrganizationNode. The output returns aPortfolioShareToken, which enables the administrator to monitor the status of thePortfolioSharecreation process. - PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- SharePrincipals
-
- Type: boolean
Enables or disables
Principalsharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled.When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of
PrincipalType:IAM_PATTERNon their portfolio. You can create the principals in the recipient account before or after creating the share. - ShareTagOptions
-
- Type: boolean
Enables or disables
TagOptionssharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.
Result Syntax
[
'PortfolioShareToken' => '<string>',
]
Result Details
Members
Errors
-
The specified resource was not found.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
CreateProduct
$result = $client->createProduct([/* ... */]); $promise = $client->createProductAsync([/* ... */]);
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
Parameter Syntax
$result = $client->createProduct([
'AcceptLanguage' => '<string>',
'Description' => '<string>',
'Distributor' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Owner' => '<string>', // REQUIRED
'ProductType' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE', // REQUIRED
'ProvisioningArtifactParameters' => [
'Description' => '<string>',
'DisableTemplateValidation' => true || false,
'Info' => ['<string>', ...],
'Name' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'SourceConnection' => [
'ConnectionParameters' => [ // REQUIRED
'CodeStar' => [
'ArtifactPath' => '<string>', // REQUIRED
'Branch' => '<string>', // REQUIRED
'ConnectionArn' => '<string>', // REQUIRED
'Repository' => '<string>', // REQUIRED
],
],
'Type' => 'CODESTAR',
],
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Description
-
- Type: string
The description of the product.
- Distributor
-
- Type: string
The distributor of the product.
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- Name
-
- Required: Yes
- Type: string
The name of the product.
- Owner
-
- Required: Yes
- Type: string
The owner of the product.
- ProductType
-
- Required: Yes
- Type: string
The type of product.
- ProvisioningArtifactParameters
-
- Type: ProvisioningArtifactProperties structure
The configuration of the provisioning artifact.
- SourceConnection
-
- Type: SourceConnection structure
Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The
SourceConnectionparameter consists of the following sub-fields.-
Type -
ConnectionParamters
- SupportDescription
-
- Type: string
The support information about the product.
- SupportEmail
-
- Type: string
The contact email for product support.
- SupportUrl
-
- Type: string
The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl. - Tags
-
- Type: Array of Tag structures
One or more tags.
Result Syntax
[
'ProductViewDetail' => [
'CreatedTime' => <DateTime>,
'ProductARN' => '<string>',
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'SourceConnection' => [
'ConnectionParameters' => [
'CodeStar' => [
'ArtifactPath' => '<string>',
'Branch' => '<string>',
'ConnectionArn' => '<string>',
'Repository' => '<string>',
],
],
'LastSync' => [
'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
'LastSuccessfulSyncTime' => <DateTime>,
'LastSyncStatus' => 'SUCCEEDED|FAILED',
'LastSyncStatusMessage' => '<string>',
'LastSyncTime' => <DateTime>,
],
'Type' => 'CODESTAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
],
'ProvisioningArtifactDetail' => [
'Active' => true || false,
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
'SourceRevision' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ProductViewDetail
-
- Type: ProductViewDetail structure
Information about the product view.
- ProvisioningArtifactDetail
-
- Type: ProvisioningArtifactDetail structure
Information about the provisioning artifact.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the product.
Errors
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
CreateProvisionedProductPlan
$result = $client->createProvisionedProductPlan([/* ... */]); $promise = $client->createProvisionedProductPlanAsync([/* ... */]);
Creates a plan.
A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.
You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.
To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
Parameter Syntax
$result = $client->createProvisionedProductPlan([
'AcceptLanguage' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'NotificationArns' => ['<string>', ...],
'PathId' => '<string>',
'PlanName' => '<string>', // REQUIRED
'PlanType' => 'CLOUDFORMATION', // REQUIRED
'ProductId' => '<string>', // REQUIRED
'ProvisionedProductName' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
'ProvisioningParameters' => [
[
'Key' => '<string>',
'UsePreviousValue' => true || false,
'Value' => '<string>',
],
// ...
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- NotificationArns
-
- Type: Array of strings
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- PathId
-
- Type: string
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
- PlanName
-
- Required: Yes
- Type: string
The name of the plan.
- PlanType
-
- Required: Yes
- Type: string
The plan type.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
- ProvisionedProductName
-
- Required: Yes
- Type: string
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
- ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact.
- ProvisioningParameters
-
- Type: Array of UpdateProvisioningParameter structures
Parameters specified by the administrator that are required for provisioning the product.
- Tags
-
- Type: Array of Tag structures
One or more tags.
If the plan is for an existing provisioned product, the product must have a
RESOURCE_UPDATEconstraint withTagUpdatesOnProvisionedProductset toALLOWEDto allow tag updates.
Result Syntax
[
'PlanId' => '<string>',
'PlanName' => '<string>',
'ProvisionProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
]
Result Details
Members
- PlanId
-
- Type: string
The plan identifier.
- PlanName
-
- Type: string
The name of the plan.
- ProvisionProductId
-
- Type: string
The product identifier.
- ProvisionedProductName
-
- Type: string
The user-friendly name of the provisioned product.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
CreateProvisioningArtifact
$result = $client->createProvisioningArtifact([/* ... */]); $promise = $client->createProvisioningArtifactAsync([/* ... */]);
Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
Parameter Syntax
$result = $client->createProvisioningArtifact([
'AcceptLanguage' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'Parameters' => [ // REQUIRED
'Description' => '<string>',
'DisableTemplateValidation' => true || false,
'Info' => ['<string>', ...],
'Name' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'ProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- Parameters
-
- Required: Yes
- Type: ProvisioningArtifactProperties structure
The configuration for the provisioning artifact.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
Result Syntax
[
'Info' => ['<string>', ...],
'ProvisioningArtifactDetail' => [
'Active' => true || false,
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
'SourceRevision' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- Info
-
- Type: Associative array of custom strings keys (ProvisioningArtifactInfoKey) to strings
Specify the template source with one of the following options, but not both. Keys accepted: [
LoadTemplateFromURL,ImportFromPhysicalId].Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
LoadTemplateFromURLUse the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
ImportFromPhysicalIdUse the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.
- ProvisioningArtifactDetail
-
- Type: ProvisioningArtifactDetail structure
Information about the provisioning artifact.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
CreateServiceAction
$result = $client->createServiceAction([/* ... */]); $promise = $client->createServiceActionAsync([/* ... */]);
Creates a self-service action.
Parameter Syntax
$result = $client->createServiceAction([
'AcceptLanguage' => '<string>',
'Definition' => ['<string>', ...], // REQUIRED
'DefinitionType' => 'SSM_AUTOMATION', // REQUIRED
'Description' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Definition
-
- Required: Yes
- Type: Associative array of custom strings keys (ServiceActionDefinitionKey) to strings
The self-service action definition. Can be one of the following:
- Name
-
The name of the Amazon Web Services Systems Manager document (SSM document). For example,
AWS-RestartEC2Instance.If you are using a shared SSM document, you must provide the ARN instead of the name.
- Version
-
The Amazon Web Services Systems Manager automation document version. For example,
"Version": "1" - AssumeRole
-
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example,
"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".To reuse the provisioned product launch role, set to
"AssumeRole": "LAUNCH_ROLE". - Parameters
-
The list of parameters in JSON format.
For example:
[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]or[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].
- DefinitionType
-
- Required: Yes
- Type: string
The service action definition type. For example,
SSM_AUTOMATION. - Description
-
- Type: string
The self-service action description.
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- Name
-
- Required: Yes
- Type: string
The self-service action name.
Result Syntax
[
'ServiceActionDetail' => [
'Definition' => ['<string>', ...],
'ServiceActionSummary' => [
'DefinitionType' => 'SSM_AUTOMATION',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ServiceActionDetail
-
- Type: ServiceActionDetail structure
An object containing information about the self-service action.
Errors
-
One or more parameters provided to the operation are not valid.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
CreateTagOption
$result = $client->createTagOption([/* ... */]); $promise = $client->createTagOptionAsync([/* ... */]);
Creates a TagOption.
Parameter Syntax
$result = $client->createTagOption([
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'TagOptionDetail' => [
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
]
Result Details
Members
- TagOptionDetail
-
- Type: TagOptionDetail structure
Information about the TagOption.
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource is a duplicate.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
DeleteConstraint
$result = $client->deleteConstraint([/* ... */]); $promise = $client->deleteConstraintAsync([/* ... */]);
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->deleteConstraint([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DeletePortfolio
$result = $client->deletePortfolio([/* ... */]); $promise = $client->deletePortfolioAsync([/* ... */]);
Deletes the specified portfolio.
You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->deletePortfolio([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
DeletePortfolioShare
$result = $client->deletePortfolioShare([/* ... */]); $promise = $client->deletePortfolioShareAsync([/* ... */]);
Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.
Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.
Parameter Syntax
$result = $client->deletePortfolioShare([
'AcceptLanguage' => '<string>',
'AccountId' => '<string>',
'OrganizationNode' => [
'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
'Value' => '<string>',
],
'PortfolioId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccountId
-
- Type: string
The Amazon Web Services account ID.
- OrganizationNode
-
- Type: OrganizationNode structure
The organization node to whom you are going to stop sharing.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
Result Syntax
[
'PortfolioShareToken' => '<string>',
]
Result Details
Members
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
DeleteProduct
$result = $client->deleteProduct([/* ... */]); $promise = $client->deleteProductAsync([/* ... */]);
Deletes the specified product.
You cannot delete a product if it was shared with you or is associated with a portfolio.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->deleteProduct([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
-
One or more parameters provided to the operation are not valid.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
DeleteProvisionedProductPlan
$result = $client->deleteProvisionedProductPlan([/* ... */]); $promise = $client->deleteProvisionedProductPlanAsync([/* ... */]);
Deletes the specified plan.
Parameter Syntax
$result = $client->deleteProvisionedProductPlan([
'AcceptLanguage' => '<string>',
'IgnoreErrors' => true || false,
'PlanId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IgnoreErrors
-
- Type: boolean
If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
- PlanId
-
- Required: Yes
- Type: string
The plan identifier.
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
DeleteProvisioningArtifact
$result = $client->deleteProvisioningArtifact([/* ... */]); $promise = $client->deleteProvisioningArtifactAsync([/* ... */]);
Deletes the specified provisioning artifact (also known as a version) for the specified product.
You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
Parameter Syntax
$result = $client->deleteProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
-
One or more parameters provided to the operation are not valid.
DeleteServiceAction
$result = $client->deleteServiceAction([/* ... */]); $promise = $client->deleteServiceActionAsync([/* ... */]);
Deletes a self-service action.
Parameter Syntax
$result = $client->deleteServiceAction([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
DeleteTagOption
$result = $client->deleteTagOption([/* ... */]); $promise = $client->deleteTagOptionAsync([/* ... */]);
Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
Parameter Syntax
$result = $client->deleteTagOption([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
-
The specified resource was not found.
DescribeConstraint
$result = $client->describeConstraint([/* ... */]); $promise = $client->describeConstraintAsync([/* ... */]);
Gets information about the specified constraint.
Parameter Syntax
$result = $client->describeConstraint([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ConstraintDetail' => [
'ConstraintId' => '<string>',
'Description' => '<string>',
'Owner' => '<string>',
'PortfolioId' => '<string>',
'ProductId' => '<string>',
'Type' => '<string>',
],
'ConstraintParameters' => '<string>',
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- ConstraintDetail
-
- Type: ConstraintDetail structure
Information about the constraint.
- ConstraintParameters
-
- Type: string
The constraint parameters.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
DescribeCopyProductStatus
$result = $client->describeCopyProductStatus([/* ... */]); $promise = $client->describeCopyProductStatusAsync([/* ... */]);
Gets the status of the specified copy product operation.
Parameter Syntax
$result = $client->describeCopyProductStatus([
'AcceptLanguage' => '<string>',
'CopyProductToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- CopyProductToken
-
- Required: Yes
- Type: string
The token for the copy product operation. This token is returned by CopyProduct.
Result Syntax
[
'CopyProductStatus' => 'SUCCEEDED|IN_PROGRESS|FAILED',
'StatusDetail' => '<string>',
'TargetProductId' => '<string>',
]
Result Details
Members
Errors
-
The specified resource was not found.
DescribePortfolio
$result = $client->describePortfolio([/* ... */]); $promise = $client->describePortfolioAsync([/* ... */]);
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->describePortfolio([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Budgets' => [
[
'BudgetName' => '<string>',
],
// ...
],
'PortfolioDetail' => [
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
'TagOptions' => [
[
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
// ...
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Budgets
-
- Type: Array of BudgetDetail structures
Information about the associated budgets.
- PortfolioDetail
-
- Type: PortfolioDetail structure
Information about the portfolio.
- TagOptions
-
- Type: Array of TagOptionDetail structures
Information about the TagOptions associated with the portfolio.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the portfolio.
Errors
-
The specified resource was not found.
DescribePortfolioShareStatus
$result = $client->describePortfolioShareStatus([/* ... */]); $promise = $client->describePortfolioShareStatusAsync([/* ... */]);
Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.
Parameter Syntax
$result = $client->describePortfolioShareStatus([
'PortfolioShareToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'OrganizationNodeValue' => '<string>',
'PortfolioId' => '<string>',
'PortfolioShareToken' => '<string>',
'ShareDetails' => [
'ShareErrors' => [
[
'Accounts' => ['<string>', ...],
'Error' => '<string>',
'Message' => '<string>',
],
// ...
],
'SuccessfulShares' => ['<string>', ...],
],
'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|ERROR',
]
Result Details
Members
- OrganizationNodeValue
-
- Type: string
Organization node identifier. It can be either account id, organizational unit id or organization id.
- PortfolioId
-
- Type: string
The portfolio identifier.
- PortfolioShareToken
-
- Type: string
The token for the portfolio share operation. For example,
share-6v24abcdefghi. - ShareDetails
-
- Type: ShareDetails structure
Information about the portfolio share operation.
- Status
-
- Type: string
Status of the portfolio share operation.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
DescribePortfolioShares
$result = $client->describePortfolioShares([/* ... */]); $promise = $client->describePortfolioSharesAsync([/* ... */]);
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.
The PortfolioId and Type parameters are both required.
Parameter Syntax
$result = $client->describePortfolioShares([
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATIONAL_UNIT|ORGANIZATION_MEMBER_ACCOUNT', // REQUIRED
]);
Parameter Details
Members
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Required: Yes
- Type: string
The unique identifier of the portfolio for which shares will be retrieved.
- Type
-
- Required: Yes
- Type: string
The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:
1.
ACCOUNT- Represents an external account to account share.2.
ORGANIZATION- Represents a share to an organization. This share is available to every account in the organization.3.
ORGANIZATIONAL_UNIT- Represents a share to an organizational unit.4.
ORGANIZATION_MEMBER_ACCOUNT- Represents a share to an account in the organization.
Result Syntax
[
'NextPageToken' => '<string>',
'PortfolioShareDetails' => [
[
'Accepted' => true || false,
'PrincipalId' => '<string>',
'SharePrincipals' => true || false,
'ShareTagOptions' => true || false,
'Type' => 'ACCOUNT|ORGANIZATION|ORGANIZATIONAL_UNIT|ORGANIZATION_MEMBER_ACCOUNT',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- PortfolioShareDetails
-
- Type: Array of PortfolioShareDetail structures
Summaries about each of the portfolio shares.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProduct
$result = $client->describeProduct([/* ... */]); $promise = $client->describeProductAsync([/* ... */]);
Gets information about the specified product.
Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.
Parameter Syntax
$result = $client->describeProduct([
'AcceptLanguage' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Budgets' => [
[
'BudgetName' => '<string>',
],
// ...
],
'LaunchPaths' => [
[
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'ProvisioningArtifacts' => [
[
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- Budgets
-
- Type: Array of BudgetDetail structures
Information about the associated budgets.
- LaunchPaths
-
- Type: Array of LaunchPath structures
Information about the associated launch paths.
- ProductViewSummary
-
- Type: ProductViewSummary structure
Summary information about the product view.
- ProvisioningArtifacts
-
- Type: Array of ProvisioningArtifact structures
Information about the provisioning artifacts for the specified product.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProductAsAdmin
$result = $client->describeProductAsAdmin([/* ... */]); $promise = $client->describeProductAsAdminAsync([/* ... */]);
Gets information about the specified product. This operation is run with administrator access.
Parameter Syntax
$result = $client->describeProductAsAdmin([
'AcceptLanguage' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'SourcePortfolioId' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Id
-
- Type: string
The product identifier.
- Name
-
- Type: string
The product name.
- SourcePortfolioId
-
- Type: string
The unique identifier of the shared portfolio that the specified product is associated with.
You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.
Result Syntax
[
'Budgets' => [
[
'BudgetName' => '<string>',
],
// ...
],
'ProductViewDetail' => [
'CreatedTime' => <DateTime>,
'ProductARN' => '<string>',
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'SourceConnection' => [
'ConnectionParameters' => [
'CodeStar' => [
'ArtifactPath' => '<string>',
'Branch' => '<string>',
'ConnectionArn' => '<string>',
'Repository' => '<string>',
],
],
'LastSync' => [
'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
'LastSuccessfulSyncTime' => <DateTime>,
'LastSyncStatus' => 'SUCCEEDED|FAILED',
'LastSyncStatusMessage' => '<string>',
'LastSyncTime' => <DateTime>,
],
'Type' => 'CODESTAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
],
'ProvisioningArtifactSummaries' => [
[
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
'ProvisioningArtifactMetadata' => ['<string>', ...],
],
// ...
],
'TagOptions' => [
[
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
// ...
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Budgets
-
- Type: Array of BudgetDetail structures
Information about the associated budgets.
- ProductViewDetail
-
- Type: ProductViewDetail structure
Information about the product view.
- ProvisioningArtifactSummaries
-
- Type: Array of ProvisioningArtifactSummary structures
Information about the provisioning artifacts (also known as versions) for the specified product.
- TagOptions
-
- Type: Array of TagOptionDetail structures
Information about the TagOptions associated with the product.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the product.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProductView
$result = $client->describeProductView([/* ... */]); $promise = $client->describeProductViewAsync([/* ... */]);
Gets information about the specified product.
Parameter Syntax
$result = $client->describeProductView([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'ProvisioningArtifacts' => [
[
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- ProductViewSummary
-
- Type: ProductViewSummary structure
Summary information about the product.
- ProvisioningArtifacts
-
- Type: Array of ProvisioningArtifact structures
Information about the provisioning artifacts for the product.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProvisionedProduct
$result = $client->describeProvisionedProduct([/* ... */]); $promise = $client->describeProvisionedProductAsync([/* ... */]);
Gets information about the specified provisioned product.
Parameter Syntax
$result = $client->describeProvisionedProduct([
'AcceptLanguage' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Id
-
- Type: string
The provisioned product identifier. You must provide the name or ID, but not both.
If you do not provide a name or ID, or you provide both name and ID, an
InvalidParametersExceptionwill occur. - Name
-
- Type: string
The name of the provisioned product. You must provide the name or ID, but not both.
If you do not provide a name or ID, or you provide both name and ID, an
InvalidParametersExceptionwill occur.
Result Syntax
[
'CloudWatchDashboards' => [
[
'Name' => '<string>',
],
// ...
],
'ProvisionedProductDetail' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'IdempotencyToken' => '<string>',
'LastProvisioningRecordId' => '<string>',
'LastRecordId' => '<string>',
'LastSuccessfulProvisioningRecordId' => '<string>',
'LaunchRoleArn' => '<string>',
'Name' => '<string>',
'ProductId' => '<string>',
'ProvisioningArtifactId' => '<string>',
'Status' => 'AVAILABLE|UNDER_CHANGE|TAINTED|ERROR|PLAN_IN_PROGRESS',
'StatusMessage' => '<string>',
'Type' => '<string>',
],
]
Result Details
Members
- CloudWatchDashboards
-
- Type: Array of CloudWatchDashboard structures
Any CloudWatch dashboards that were created when provisioning the product.
- ProvisionedProductDetail
-
- Type: ProvisionedProductDetail structure
Information about the provisioned product.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProvisionedProductPlan
$result = $client->describeProvisionedProductPlan([/* ... */]); $promise = $client->describeProvisionedProductPlanAsync([/* ... */]);
Gets information about the resource changes for the specified plan.
Parameter Syntax
$result = $client->describeProvisionedProductPlan([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'PlanId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PlanId
-
- Required: Yes
- Type: string
The plan identifier.
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisionedProductPlanDetails' => [
'CreatedTime' => <DateTime>,
'NotificationArns' => ['<string>', ...],
'PathId' => '<string>',
'PlanId' => '<string>',
'PlanName' => '<string>',
'PlanType' => 'CLOUDFORMATION',
'ProductId' => '<string>',
'ProvisionProductId' => '<string>',
'ProvisionProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ProvisioningParameters' => [
[
'Key' => '<string>',
'UsePreviousValue' => true || false,
'Value' => '<string>',
],
// ...
],
'Status' => 'CREATE_IN_PROGRESS|CREATE_SUCCESS|CREATE_FAILED|EXECUTE_IN_PROGRESS|EXECUTE_SUCCESS|EXECUTE_FAILED',
'StatusMessage' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'UpdatedTime' => <DateTime>,
],
'ResourceChanges' => [
[
'Action' => 'ADD|MODIFY|REMOVE',
'Details' => [
[
'CausingEntity' => '<string>',
'Evaluation' => 'STATIC|DYNAMIC',
'Target' => [
'Attribute' => 'PROPERTIES|METADATA|CREATIONPOLICY|UPDATEPOLICY|DELETIONPOLICY|TAGS',
'Name' => '<string>',
'RequiresRecreation' => 'NEVER|CONDITIONALLY|ALWAYS',
],
],
// ...
],
'LogicalResourceId' => '<string>',
'PhysicalResourceId' => '<string>',
'Replacement' => 'TRUE|FALSE|CONDITIONAL',
'ResourceType' => '<string>',
'Scope' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisionedProductPlanDetails
-
- Type: ProvisionedProductPlanDetails structure
Information about the plan.
- ResourceChanges
-
- Type: Array of ResourceChange structures
Information about the resource changes that will occur when the plan is executed.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProvisioningArtifact
$result = $client->describeProvisioningArtifact([/* ... */]); $promise = $client->describeProvisioningArtifactAsync([/* ... */]);
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
Parameter Syntax
$result = $client->describeProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ProductId' => '<string>',
'ProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ProvisioningArtifactName' => '<string>',
'Verbose' => true || false,
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ProductId
-
- Type: string
The product identifier.
- ProductName
-
- Type: string
The product name.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
- ProvisioningArtifactName
-
- Type: string
The provisioning artifact name.
- Verbose
-
- Type: boolean
Indicates whether a verbose level of detail is enabled.
Result Syntax
[
'Info' => ['<string>', ...],
'ProvisioningArtifactDetail' => [
'Active' => true || false,
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
'SourceRevision' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- Info
-
- Type: Associative array of custom strings keys (ProvisioningArtifactInfoKey) to strings
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
- ProvisioningArtifactDetail
-
- Type: ProvisioningArtifactDetail structure
Information about the provisioning artifact.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
DescribeProvisioningParameters
$result = $client->describeProvisioningParameters([/* ... */]); $promise = $client->describeProvisioningParametersAsync([/* ... */]);
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.
Parameter Syntax
$result = $client->describeProvisioningParameters([
'AcceptLanguage' => '<string>',
'PathId' => '<string>',
'PathName' => '<string>',
'ProductId' => '<string>',
'ProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ProvisioningArtifactName' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PathId
-
- Type: string
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
- PathName
-
- Type: string
The name of the path. You must provide the name or ID, but not both.
- ProductId
-
- Type: string
The product identifier. You must provide the product name or ID, but not both.
- ProductName
-
- Type: string
The name of the product. You must provide the name or ID, but not both.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
- ProvisioningArtifactName
-
- Type: string
The name of the provisioning artifact. You must provide the name or ID, but not both.
Result Syntax
[
'ConstraintSummaries' => [
[
'Description' => '<string>',
'Type' => '<string>',
],
// ...
],
'ProvisioningArtifactOutputKeys' => [
[
'Description' => '<string>',
'Key' => '<string>',
],
// ...
],
'ProvisioningArtifactOutputs' => [
[
'Description' => '<string>',
'Key' => '<string>',
],
// ...
],
'ProvisioningArtifactParameters' => [
[
'DefaultValue' => '<string>',
'Description' => '<string>',
'IsNoEcho' => true || false,
'ParameterConstraints' => [
'AllowedPattern' => '<string>',
'AllowedValues' => ['<string>', ...],
'ConstraintDescription' => '<string>',
'MaxLength' => '<string>',
'MaxValue' => '<string>',
'MinLength' => '<string>',
'MinValue' => '<string>',
],
'ParameterKey' => '<string>',
'ParameterType' => '<string>',
],
// ...
],
'ProvisioningArtifactPreferences' => [
'StackSetAccounts' => ['<string>', ...],
'StackSetRegions' => ['<string>', ...],
],
'TagOptions' => [
[
'Key' => '<string>',
'Values' => ['<string>', ...],
],
// ...
],
'UsageInstructions' => [
[
'Type' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ConstraintSummaries
-
- Type: Array of ConstraintSummary structures
Information about the constraints used to provision the product.
- ProvisioningArtifactOutputKeys
-
- Type: Array of ProvisioningArtifactOutput structures
A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
- ProvisioningArtifactOutputs
-
- Type: Array of ProvisioningArtifactOutput structures
The output of the provisioning artifact.
- ProvisioningArtifactParameters
-
- Type: Array of ProvisioningArtifactParameter structures
Information about the parameters used to provision the product.
- ProvisioningArtifactPreferences
-
- Type: ProvisioningArtifactPreferences structure
An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.
- TagOptions
-
- Type: Array of TagOptionSummary structures
Information about the TagOptions associated with the resource.
- UsageInstructions
-
- Type: Array of UsageInstruction structures
Any additional metadata specifically related to the provisioning of the product. For example, see the
Versionfield of the CloudFormation template.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
DescribeRecord
$result = $client->describeRecord([/* ... */]); $promise = $client->describeRecordAsync([/* ... */]);
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.
Parameter Syntax
$result = $client->describeRecord([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
'PageSize' => <integer>,
'PageToken' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Id
-
- Required: Yes
- Type: string
The record identifier of the provisioned product. This identifier is returned by the request operation.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
Result Syntax
[
'NextPageToken' => '<string>',
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
'RecordOutputs' => [
[
'Description' => '<string>',
'OutputKey' => '<string>',
'OutputValue' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- RecordDetail
-
- Type: RecordDetail structure
Information about the product.
- RecordOutputs
-
- Type: Array of RecordOutput structures
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.
Errors
-
The specified resource was not found.
DescribeServiceAction
$result = $client->describeServiceAction([/* ... */]); $promise = $client->describeServiceActionAsync([/* ... */]);
Describes a self-service action.
Parameter Syntax
$result = $client->describeServiceAction([
'AcceptLanguage' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ServiceActionDetail' => [
'Definition' => ['<string>', ...],
'ServiceActionSummary' => [
'DefinitionType' => 'SSM_AUTOMATION',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ServiceActionDetail
-
- Type: ServiceActionDetail structure
Detailed information about the self-service action.
Errors
-
The specified resource was not found.
DescribeServiceActionExecutionParameters
$result = $client->describeServiceActionExecutionParameters([/* ... */]); $promise = $client->describeServiceActionExecutionParametersAsync([/* ... */]);
Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.
Parameter Syntax
$result = $client->describeServiceActionExecutionParameters([
'AcceptLanguage' => '<string>',
'ProvisionedProductId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ServiceActionParameters' => [
[
'DefaultValues' => ['<string>', ...],
'Name' => '<string>',
'Type' => '<string>',
],
// ...
],
]
Result Details
Members
- ServiceActionParameters
-
- Type: Array of ExecutionParameter structures
The parameters of the self-service action.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
DescribeTagOption
$result = $client->describeTagOption([/* ... */]); $promise = $client->describeTagOptionAsync([/* ... */]);
Gets information about the specified TagOption.
Parameter Syntax
$result = $client->describeTagOption([
'Id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'TagOptionDetail' => [
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
]
Result Details
Members
- TagOptionDetail
-
- Type: TagOptionDetail structure
Information about the TagOption.
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource was not found.
DisableAWSOrganizationsAccess
$result = $client->disableAWSOrganizationsAccess([/* ... */]); $promise = $client->disableAWSOrganizationsAccessAsync([/* ... */]);
Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.
You cannot call this API if there are active delegated administrators in the organization.
Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.
If you share an Service Catalog portfolio in an organization within Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.
Parameter Syntax
$result = $client->disableAWSOrganizationsAccess([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
-
OperationNotSupportedException:
The operation is not supported.
DisassociateBudgetFromResource
$result = $client->disassociateBudgetFromResource([/* ... */]); $promise = $client->disassociateBudgetFromResourceAsync([/* ... */]);
Disassociates the specified budget from the specified resource.
Parameter Syntax
$result = $client->disassociateBudgetFromResource([
'BudgetName' => '<string>', // REQUIRED
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
DisassociatePrincipalFromPortfolio
$result = $client->disassociatePrincipalFromPortfolio([/* ... */]); $promise = $client->disassociatePrincipalFromPortfolioAsync([/* ... */]);
Disassociates a previously associated principal ARN from a specified portfolio.
The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio.
For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.
Parameter Syntax
$result = $client->disassociatePrincipalFromPortfolio([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'PrincipalARN' => '<string>', // REQUIRED
'PrincipalType' => 'IAM|IAM_PATTERN',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- PrincipalARN
-
- Required: Yes
- Type: string
The ARN of the principal (IAM user, role, or group). This field allows an ARN with no
accountIDifPrincipalTypeisIAM_PATTERN. - PrincipalType
-
- Type: string
The supported value is
IAMif you use a fully defined ARN, orIAM_PATTERNif you use noaccountID.
Result Syntax
[]
Result Details
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
DisassociateProductFromPortfolio
$result = $client->disassociateProductFromPortfolio([/* ... */]); $promise = $client->disassociateProductFromPortfolioAsync([/* ... */]);
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
Parameter Syntax
$result = $client->disassociateProductFromPortfolio([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'ProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
-
One or more parameters provided to the operation are not valid.
DisassociateServiceActionFromProvisioningArtifact
$result = $client->disassociateServiceActionFromProvisioningArtifact([/* ... */]); $promise = $client->disassociateServiceActionFromProvisioningArtifactAsync([/* ... */]);
Disassociates the specified self-service action association from the specified provisioning artifact.
Parameter Syntax
$result = $client->disassociateServiceActionFromProvisioningArtifact([
'AcceptLanguage' => '<string>',
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ProductId
-
- Required: Yes
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne. - ServiceActionId
-
- Required: Yes
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
DisassociateTagOptionFromResource
$result = $client->disassociateTagOptionFromResource([/* ... */]); $promise = $client->disassociateTagOptionFromResourceAsync([/* ... */]);
Disassociates the specified TagOption from the specified resource.
Parameter Syntax
$result = $client->disassociateTagOptionFromResource([
'ResourceId' => '<string>', // REQUIRED
'TagOptionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource was not found.
EnableAWSOrganizationsAccess
$result = $client->enableAWSOrganizationsAccess([/* ... */]); $promise = $client->enableAWSOrganizationsAccessAsync([/* ... */]);
Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.
When you call this API, Service Catalog calls organizations:EnableAWSServiceAccess on your behalf so that your shares stay in sync with any changes in your Organizations structure.
Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.
If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage Amazon Web Services resources when it is no longer authorized to do so. Amazon Web Services is working to resolve this issue.
Parameter Syntax
$result = $client->enableAWSOrganizationsAccess([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
-
OperationNotSupportedException:
The operation is not supported.
ExecuteProvisionedProductPlan
$result = $client->executeProvisionedProductPlan([/* ... */]); $promise = $client->executeProvisionedProductPlanAsync([/* ... */]);
Provisions or modifies a product based on the resource changes for the specified plan.
Parameter Syntax
$result = $client->executeProvisionedProductPlan([
'AcceptLanguage' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'PlanId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- PlanId
-
- Required: Yes
- Type: string
The plan identifier.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
Information about the result of provisioning the product.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
ExecuteProvisionedProductServiceAction
$result = $client->executeProvisionedProductServiceAction([/* ... */]); $promise = $client->executeProvisionedProductServiceActionAsync([/* ... */]);
Executes a self-service action against a provisioned product.
Parameter Syntax
$result = $client->executeProvisionedProductServiceAction([
'AcceptLanguage' => '<string>',
'ExecuteToken' => '<string>', // REQUIRED
'Parameters' => [
'<ExecutionParameterKey>' => ['<string>', ...],
// ...
],
'ProvisionedProductId' => '<string>', // REQUIRED
'ServiceActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- ExecuteToken
-
- Required: Yes
- Type: string
An idempotency token that uniquely identifies the execute request.
- Parameters
-
- Type: Associative array of custom strings keys (ExecutionParameterKey) to stringss
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 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 asTARGET. - ProvisionedProductId
-
- Required: Yes
- Type: string
The identifier of the provisioned product.
- ServiceActionId
-
- Required: Yes
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
An object containing detailed information about the result of provisioning the product.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
GetAWSOrganizationsAccessStatus
$result = $client->getAWSOrganizationsAccessStatus([/* ... */]); $promise = $client->getAWSOrganizationsAccessStatusAsync([/* ... */]);
Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.
Parameter Syntax
$result = $client->getAWSOrganizationsAccessStatus([ ]);
Parameter Details
Members
Result Syntax
[
'AccessStatus' => 'ENABLED|UNDER_CHANGE|DISABLED',
]
Result Details
Errors
-
The specified resource was not found.
-
OperationNotSupportedException:
The operation is not supported.
GetProvisionedProductOutputs
$result = $client->getProvisionedProductOutputs([/* ... */]); $promise = $client->getProvisionedProductOutputsAsync([/* ... */]);
This API takes either a ProvisonedProductId or a ProvisionedProductName, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
Parameter Syntax
$result = $client->getProvisionedProductOutputs([
'AcceptLanguage' => '<string>',
'OutputKeys' => ['<string>', ...],
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- OutputKeys
-
- Type: Array of strings
The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProvisionedProductId
-
- Type: string
The identifier of the provisioned product that you want the outputs from.
- ProvisionedProductName
-
- Type: string
The name of the provisioned product that you want the outputs from.
Result Syntax
[
'NextPageToken' => '<string>',
'Outputs' => [
[
'Description' => '<string>',
'OutputKey' => '<string>',
'OutputValue' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- Outputs
-
- Type: Array of RecordOutput structures
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.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
ImportAsProvisionedProduct
$result = $client->importAsProvisionedProduct([/* ... */]); $promise = $client->importAsProvisionedProductAsync([/* ... */]);
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.
Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks are not supported.
The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE.
Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact.
When you import an existing CloudFormation stack into a portfolio, constraints that are associated with the product aren't applied during the import process. The constraints are applied after you call UpdateProvisionedProduct for the provisioned product.
The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.
Parameter Syntax
$result = $client->importAsProvisionedProduct([
'AcceptLanguage' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'PhysicalId' => '<string>', // REQUIRED
'ProductId' => '<string>', // REQUIRED
'ProvisionedProductName' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IdempotencyToken
-
- Required: Yes
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- PhysicalId
-
- Required: Yes
- Type: string
The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
- ProvisionedProductName
-
- Required: Yes
- Type: string
The user-friendly name of the provisioned product. The value must be unique for the Amazon Web Services account. The name cannot be updated after the product is provisioned.
- ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
Information about a request operation.
Errors
-
The specified resource is a duplicate.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListAcceptedPortfolioShares
$result = $client->listAcceptedPortfolioShares([/* ... */]); $promise = $client->listAcceptedPortfolioSharesAsync([/* ... */]);
Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.
Parameter Syntax
$result = $client->listAcceptedPortfolioShares([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioShareType' => 'IMPORTED|AWS_SERVICECATALOG|AWS_ORGANIZATIONS',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioShareType
-
- Type: string
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.
Result Syntax
[
'NextPageToken' => '<string>',
'PortfolioDetails' => [
[
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- PortfolioDetails
-
- Type: Array of PortfolioDetail structures
Information about the portfolios.
Errors
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
ListBudgetsForResource
$result = $client->listBudgetsForResource([/* ... */]); $promise = $client->listBudgetsForResourceAsync([/* ... */]);
Lists all the budgets associated to the specified resource.
Parameter Syntax
$result = $client->listBudgetsForResource([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ResourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ResourceId
-
- Required: Yes
- Type: string
The resource identifier.
Result Syntax
[
'Budgets' => [
[
'BudgetName' => '<string>',
],
// ...
],
'NextPageToken' => '<string>',
]
Result Details
Members
- Budgets
-
- Type: Array of BudgetDetail structures
Information about the associated budgets.
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListConstraintsForPortfolio
$result = $client->listConstraintsForPortfolio([/* ... */]); $promise = $client->listConstraintsForPortfolioAsync([/* ... */]);
Lists the constraints for the specified portfolio and product.
Parameter Syntax
$result = $client->listConstraintsForPortfolio([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'ProductId' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- ProductId
-
- Type: string
The product identifier.
Result Syntax
[
'ConstraintDetails' => [
[
'ConstraintId' => '<string>',
'Description' => '<string>',
'Owner' => '<string>',
'PortfolioId' => '<string>',
'ProductId' => '<string>',
'Type' => '<string>',
],
// ...
],
'NextPageToken' => '<string>',
]
Result Details
Members
- ConstraintDetails
-
- Type: Array of ConstraintDetail structures
Information about the constraints.
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListLaunchPaths
$result = $client->listLaunchPaths([/* ... */]); $promise = $client->listLaunchPathsAsync([/* ... */]);
Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
Parameter Syntax
$result = $client->listLaunchPaths([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
Result Syntax
[
'LaunchPathSummaries' => [
[
'ConstraintSummaries' => [
[
'Description' => '<string>',
'Type' => '<string>',
],
// ...
],
'Id' => '<string>',
'Name' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
],
// ...
],
'NextPageToken' => '<string>',
]
Result Details
Members
- LaunchPathSummaries
-
- Type: Array of LaunchPathSummary structures
Information about the launch path.
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
ListOrganizationPortfolioAccess
$result = $client->listOrganizationPortfolioAccess([/* ... */]); $promise = $client->listOrganizationPortfolioAccessAsync([/* ... */]);
Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.
If a delegated admin is de-registered, they can no longer perform this operation.
Parameter Syntax
$result = $client->listOrganizationPortfolioAccess([
'AcceptLanguage' => '<string>',
'OrganizationNodeType' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT', // REQUIRED
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- OrganizationNodeType
-
- Required: Yes
- Type: string
The organization node type that will be returned in the output.
-
ORGANIZATION- Organization that has access to the portfolio. -
ORGANIZATIONAL_UNIT- Organizational unit that has access to the portfolio within your organization. -
ACCOUNT- Account that has access to the portfolio within your organization.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier. For example,
port-2abcdext3y5fk.
Result Syntax
[
'NextPageToken' => '<string>',
'OrganizationNodes' => [
[
'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- OrganizationNodes
-
- Type: Array of OrganizationNode structures
Displays information about the organization nodes.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
ListPortfolioAccess
$result = $client->listPortfolioAccess([/* ... */]); $promise = $client->listPortfolioAccessAsync([/* ... */]);
Lists the account IDs that have access to the specified portfolio.
A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.
Parameter Syntax
$result = $client->listPortfolioAccess([
'AcceptLanguage' => '<string>',
'OrganizationParentId' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- OrganizationParentId
-
- Type: string
The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
Result Syntax
[
'AccountIds' => ['<string>', ...],
'NextPageToken' => '<string>',
]
Result Details
Members
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListPortfolios
$result = $client->listPortfolios([/* ... */]); $promise = $client->listPortfoliosAsync([/* ... */]);
Lists all portfolios in the catalog.
Parameter Syntax
$result = $client->listPortfolios([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextPageToken' => '<string>',
'PortfolioDetails' => [
[
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- PortfolioDetails
-
- Type: Array of PortfolioDetail structures
Information about the portfolios.
Errors
-
One or more parameters provided to the operation are not valid.
ListPortfoliosForProduct
$result = $client->listPortfoliosForProduct([/* ... */]); $promise = $client->listPortfoliosForProductAsync([/* ... */]);
Lists all portfolios that the specified product is associated with.
Parameter Syntax
$result = $client->listPortfoliosForProduct([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
Result Syntax
[
'NextPageToken' => '<string>',
'PortfolioDetails' => [
[
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- PortfolioDetails
-
- Type: Array of PortfolioDetail structures
Information about the portfolios.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
ListPrincipalsForPortfolio
$result = $client->listPrincipalsForPortfolio([/* ... */]); $promise = $client->listPrincipalsForPortfolioAsync([/* ... */]);
Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.
Parameter Syntax
$result = $client->listPrincipalsForPortfolio([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
Result Syntax
[
'NextPageToken' => '<string>',
'Principals' => [
[
'PrincipalARN' => '<string>',
'PrincipalType' => 'IAM|IAM_PATTERN',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- Principals
-
- Type: Array of Principal structures
The
PrincipalARNs and correspondingPrincipalTypes associated with the portfolio.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListProvisionedProductPlans
$result = $client->listProvisionedProductPlans([/* ... */]); $promise = $client->listProvisionedProductPlansAsync([/* ... */]);
Lists the plans for the specified provisioned product or all plans to which the user has access.
Parameter Syntax
$result = $client->listProvisionedProductPlans([
'AcceptLanguage' => '<string>',
'AccessLevelFilter' => [
'Key' => 'Account|Role|User',
'Value' => '<string>',
],
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProvisionProductId' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccessLevelFilter
-
- Type: AccessLevelFilter structure
The access level to use to obtain results. The default is
User. - PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProvisionProductId
-
- Type: string
The product identifier.
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisionedProductPlans' => [
[
'PlanId' => '<string>',
'PlanName' => '<string>',
'PlanType' => 'CLOUDFORMATION',
'ProvisionProductId' => '<string>',
'ProvisionProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisionedProductPlans
-
- Type: Array of ProvisionedProductPlanSummary structures
Information about the plans.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListProvisioningArtifacts
$result = $client->listProvisioningArtifacts([/* ... */]); $promise = $client->listProvisioningArtifactsAsync([/* ... */]);
Lists all provisioning artifacts (also known as versions) for the specified product.
Parameter Syntax
$result = $client->listProvisioningArtifacts([
'AcceptLanguage' => '<string>',
'ProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisioningArtifactDetails' => [
[
'Active' => true || false,
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
'SourceRevision' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisioningArtifactDetails
-
- Type: Array of ProvisioningArtifactDetail structures
Information about the provisioning artifacts.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListProvisioningArtifactsForServiceAction
$result = $client->listProvisioningArtifactsForServiceAction([/* ... */]); $promise = $client->listProvisioningArtifactsForServiceActionAsync([/* ... */]);
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
Parameter Syntax
$result = $client->listProvisioningArtifactsForServiceAction([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ServiceActionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ServiceActionId
-
- Required: Yes
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisioningArtifactViews' => [
[
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'ProvisioningArtifact' => [
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
],
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisioningArtifactViews
-
- Type: Array of ProvisioningArtifactView structures
An array of objects with information about product views and provisioning artifacts.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListRecordHistory
$result = $client->listRecordHistory([/* ... */]); $promise = $client->listRecordHistoryAsync([/* ... */]);
Lists the specified requests or all performed requests.
Parameter Syntax
$result = $client->listRecordHistory([
'AcceptLanguage' => '<string>',
'AccessLevelFilter' => [
'Key' => 'Account|Role|User',
'Value' => '<string>',
],
'PageSize' => <integer>,
'PageToken' => '<string>',
'SearchFilter' => [
'Key' => '<string>',
'Value' => '<string>',
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccessLevelFilter
-
- Type: AccessLevelFilter structure
The access level to use to obtain results. The default is
User. - PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- SearchFilter
-
- Type: ListRecordHistorySearchFilter structure
The search filter to scope the results.
Result Syntax
[
'NextPageToken' => '<string>',
'RecordDetails' => [
[
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- RecordDetails
-
- Type: Array of RecordDetail structures
The records, in reverse chronological order.
Errors
-
One or more parameters provided to the operation are not valid.
ListResourcesForTagOption
$result = $client->listResourcesForTagOption([/* ... */]); $promise = $client->listResourcesForTagOptionAsync([/* ... */]);
Lists the resources associated with the specified TagOption.
Parameter Syntax
$result = $client->listResourcesForTagOption([
'PageSize' => <integer>,
'PageToken' => '<string>',
'ResourceType' => '<string>',
'TagOptionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ResourceType
-
- Type: string
The resource type.
-
Portfolio -
Product
- TagOptionId
-
- Required: Yes
- Type: string
The TagOption identifier.
Result Syntax
[
'PageToken' => '<string>',
'ResourceDetails' => [
[
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ResourceDetails
-
- Type: Array of ResourceDetail structures
Information about the resources.
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListServiceActions
$result = $client->listServiceActions([/* ... */]); $promise = $client->listServiceActionsAsync([/* ... */]);
Lists all self-service actions.
Parameter Syntax
$result = $client->listServiceActions([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextPageToken' => '<string>',
'ServiceActionSummaries' => [
[
'DefinitionType' => 'SSM_AUTOMATION',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ServiceActionSummaries
-
- Type: Array of ServiceActionSummary structures
An object containing information about the service actions associated with the provisioning artifact.
Errors
-
One or more parameters provided to the operation are not valid.
ListServiceActionsForProvisioningArtifact
$result = $client->listServiceActionsForProvisioningArtifact([/* ... */]); $promise = $client->listServiceActionsForProvisioningArtifactAsync([/* ... */]);
Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
Parameter Syntax
$result = $client->listServiceActionsForProvisioningArtifact([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProductId
-
- Required: Yes
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne.
Result Syntax
[
'NextPageToken' => '<string>',
'ServiceActionSummaries' => [
[
'DefinitionType' => 'SSM_AUTOMATION',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ServiceActionSummaries
-
- Type: Array of ServiceActionSummary structures
An object containing information about the self-service actions associated with the provisioning artifact.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
ListStackInstancesForProvisionedProduct
$result = $client->listStackInstancesForProvisionedProduct([/* ... */]); $promise = $client->listStackInstancesForProvisionedProductAsync([/* ... */]);
Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.
Parameter Syntax
$result = $client->listStackInstancesForProvisionedProduct([
'AcceptLanguage' => '<string>',
'PageSize' => <integer>,
'PageToken' => '<string>',
'ProvisionedProductId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- ProvisionedProductId
-
- Required: Yes
- Type: string
The identifier of the provisioned product.
Result Syntax
[
'NextPageToken' => '<string>',
'StackInstances' => [
[
'Account' => '<string>',
'Region' => '<string>',
'StackInstanceStatus' => 'CURRENT|OUTDATED|INOPERABLE',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- StackInstances
-
- Type: Array of StackInstance structures
List of stack instances.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
ListTagOptions
$result = $client->listTagOptions([/* ... */]); $promise = $client->listTagOptionsAsync([/* ... */]);
Lists the specified TagOptions or all TagOptions.
Parameter Syntax
$result = $client->listTagOptions([
'Filters' => [
'Active' => true || false,
'Key' => '<string>',
'Value' => '<string>',
],
'PageSize' => <integer>,
'PageToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: ListTagOptionsFilters structure
The search filters. If no search filters are specified, the output includes all TagOptions.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
Result Syntax
[
'PageToken' => '<string>',
'TagOptionDetails' => [
[
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- TagOptionDetails
-
- Type: Array of TagOptionDetail structures
Information about the TagOptions.
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
One or more parameters provided to the operation are not valid.
ProvisionProduct
$result = $client->provisionProduct([/* ... */]); $promise = $client->provisionProductAsync([/* ... */]);
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".
When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.
Parameter Syntax
$result = $client->provisionProduct([
'AcceptLanguage' => '<string>',
'NotificationArns' => ['<string>', ...],
'PathId' => '<string>',
'PathName' => '<string>',
'ProductId' => '<string>',
'ProductName' => '<string>',
'ProvisionToken' => '<string>', // REQUIRED
'ProvisionedProductName' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>',
'ProvisioningArtifactName' => '<string>',
'ProvisioningParameters' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'ProvisioningPreferences' => [
'StackSetAccounts' => ['<string>', ...],
'StackSetFailureToleranceCount' => <integer>,
'StackSetFailureTolerancePercentage' => <integer>,
'StackSetMaxConcurrencyCount' => <integer>,
'StackSetMaxConcurrencyPercentage' => <integer>,
'StackSetRegions' => ['<string>', ...],
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- NotificationArns
-
- Type: Array of strings
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- PathId
-
- Type: string
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
- PathName
-
- Type: string
The name of the path. You must provide the name or ID, but not both.
- ProductId
-
- Type: string
The product identifier. You must provide the name or ID, but not both.
- ProductName
-
- Type: string
The name of the product. You must provide the name or ID, but not both.
- ProvisionToken
-
- Required: Yes
- Type: string
An idempotency token that uniquely identifies the provisioning request.
- ProvisionedProductName
-
- Required: Yes
- Type: string
A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
- ProvisioningArtifactName
-
- Type: string
The name of the provisioning artifact. You must provide the name or ID, but not both.
- ProvisioningParameters
-
- Type: Array of ProvisioningParameter structures
Parameters specified by the administrator that are required for provisioning the product.
- ProvisioningPreferences
-
- Type: ProvisioningPreferences structure
An object that contains information about the provisioning preferences for a stack set.
- Tags
-
- Type: Array of Tag structures
One or more tags.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
Information about the result of provisioning the product.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
The specified resource is a duplicate.
RejectPortfolioShare
$result = $client->rejectPortfolioShare([/* ... */]); $promise = $client->rejectPortfolioShareAsync([/* ... */]);
Rejects an offer to share the specified portfolio.
Parameter Syntax
$result = $client->rejectPortfolioShare([
'AcceptLanguage' => '<string>',
'PortfolioId' => '<string>', // REQUIRED
'PortfolioShareType' => 'IMPORTED|AWS_SERVICECATALOG|AWS_ORGANIZATIONS',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PortfolioId
-
- Required: Yes
- Type: string
The portfolio identifier.
- PortfolioShareType
-
- Type: string
The type of shared portfolios to reject. The default is to reject imported portfolios.
-
AWS_ORGANIZATIONS- Reject portfolios shared by the management account of your organization. -
IMPORTED- Reject imported portfolios. -
AWS_SERVICECATALOG- Not supported. (Throws ResourceNotFoundException.)
For example,
aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS
Result Syntax
[]
Result Details
Errors
-
The specified resource was not found.
ScanProvisionedProducts
$result = $client->scanProvisionedProducts([/* ... */]); $promise = $client->scanProvisionedProductsAsync([/* ... */]);
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
Parameter Syntax
$result = $client->scanProvisionedProducts([
'AcceptLanguage' => '<string>',
'AccessLevelFilter' => [
'Key' => 'Account|Role|User',
'Value' => '<string>',
],
'PageSize' => <integer>,
'PageToken' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccessLevelFilter
-
- Type: AccessLevelFilter structure
The access level to use to obtain results. The default is
User. - PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisionedProducts' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'IdempotencyToken' => '<string>',
'LastProvisioningRecordId' => '<string>',
'LastRecordId' => '<string>',
'LastSuccessfulProvisioningRecordId' => '<string>',
'LaunchRoleArn' => '<string>',
'Name' => '<string>',
'ProductId' => '<string>',
'ProvisioningArtifactId' => '<string>',
'Status' => 'AVAILABLE|UNDER_CHANGE|TAINTED|ERROR|PLAN_IN_PROGRESS',
'StatusMessage' => '<string>',
'Type' => '<string>',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisionedProducts
-
- Type: Array of ProvisionedProductDetail structures
Information about the provisioned products.
Errors
-
One or more parameters provided to the operation are not valid.
SearchProducts
$result = $client->searchProducts([/* ... */]); $promise = $client->searchProductsAsync([/* ... */]);
Gets information about the products to which the caller has access.
Parameter Syntax
$result = $client->searchProducts([
'AcceptLanguage' => '<string>',
'Filters' => [
'<ProductViewFilterBy>' => ['<string>', ...],
// ...
],
'PageSize' => <integer>,
'PageToken' => '<string>',
'SortBy' => 'Title|VersionCount|CreationDate',
'SortOrder' => 'ASCENDING|DESCENDING',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Filters
-
- Type: Associative array of custom strings keys (ProductViewFilterBy) to stringss
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- SortBy
-
- Type: string
The sort field. If no value is specified, the results are not sorted.
- SortOrder
-
- Type: string
The sort order. If no value is specified, the results are not sorted.
Result Syntax
[
'NextPageToken' => '<string>',
'ProductViewAggregations' => [
'<ProductViewAggregationType>' => [
[
'ApproximateCount' => <integer>,
'Value' => '<string>',
],
// ...
],
// ...
],
'ProductViewSummaries' => [
[
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProductViewAggregations
-
- Type: Associative array of custom strings keys (ProductViewAggregationType) to ProductViewAggregationValue structuress
The product view aggregations.
- ProductViewSummaries
-
- Type: Array of ProductViewSummary structures
Information about the product views.
Errors
-
One or more parameters provided to the operation are not valid.
SearchProductsAsAdmin
$result = $client->searchProductsAsAdmin([/* ... */]); $promise = $client->searchProductsAsAdminAsync([/* ... */]);
Gets information about the products for the specified portfolio or all products.
Parameter Syntax
$result = $client->searchProductsAsAdmin([
'AcceptLanguage' => '<string>',
'Filters' => [
'<ProductViewFilterBy>' => ['<string>', ...],
// ...
],
'PageSize' => <integer>,
'PageToken' => '<string>',
'PortfolioId' => '<string>',
'ProductSource' => 'ACCOUNT',
'SortBy' => 'Title|VersionCount|CreationDate',
'SortOrder' => 'ASCENDING|DESCENDING',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Filters
-
- Type: Associative array of custom strings keys (ProductViewFilterBy) to stringss
The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
- PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- PortfolioId
-
- Type: string
The portfolio identifier.
- ProductSource
-
- Type: string
Access level of the source of the product.
- SortBy
-
- Type: string
The sort field. If no value is specified, the results are not sorted.
- SortOrder
-
- Type: string
The sort order. If no value is specified, the results are not sorted.
Result Syntax
[
'NextPageToken' => '<string>',
'ProductViewDetails' => [
[
'CreatedTime' => <DateTime>,
'ProductARN' => '<string>',
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'SourceConnection' => [
'ConnectionParameters' => [
'CodeStar' => [
'ArtifactPath' => '<string>',
'Branch' => '<string>',
'ConnectionArn' => '<string>',
'Repository' => '<string>',
],
],
'LastSync' => [
'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
'LastSuccessfulSyncTime' => <DateTime>,
'LastSyncStatus' => 'SUCCEEDED|FAILED',
'LastSyncStatusMessage' => '<string>',
'LastSyncTime' => <DateTime>,
],
'Type' => 'CODESTAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
],
// ...
],
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProductViewDetails
-
- Type: Array of ProductViewDetail structures
Information about the product views.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
SearchProvisionedProducts
$result = $client->searchProvisionedProducts([/* ... */]); $promise = $client->searchProvisionedProductsAsync([/* ... */]);
Gets information about the provisioned products that meet the specified criteria.
Parameter Syntax
$result = $client->searchProvisionedProducts([
'AcceptLanguage' => '<string>',
'AccessLevelFilter' => [
'Key' => 'Account|Role|User',
'Value' => '<string>',
],
'Filters' => [
'<ProvisionedProductViewFilterBy>' => ['<string>', ...],
// ...
],
'PageSize' => <integer>,
'PageToken' => '<string>',
'SortBy' => '<string>',
'SortOrder' => 'ASCENDING|DESCENDING',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccessLevelFilter
-
- Type: AccessLevelFilter structure
The access level to use to obtain results. The default is
User. - Filters
-
- Type: Associative array of custom strings keys (ProvisionedProductViewFilterBy) to stringss
The search filters.
When the key is
SearchQuery, the searchable fields arearn,createdTime,id,lastRecordId,idempotencyToken,name,physicalId,productId,provisioningArtifact,type,status,tags,userArn,userArnSession,lastProvisioningRecordId,lastSuccessfulProvisioningRecordId,productName, andprovisioningArtifactName.Example:
"SearchQuery":["status:AVAILABLE"] - PageSize
-
- Type: int
The maximum number of items to return with this call.
- PageToken
-
- Type: string
The page token for the next set of results. To retrieve the first set of results, use null.
- SortBy
-
- Type: string
The sort field. If no value is specified, the results are not sorted. The valid values are
arn,id,name, andlastRecordId. - SortOrder
-
- Type: string
The sort order. If no value is specified, the results are not sorted.
Result Syntax
[
'NextPageToken' => '<string>',
'ProvisionedProducts' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Id' => '<string>',
'IdempotencyToken' => '<string>',
'LastProvisioningRecordId' => '<string>',
'LastRecordId' => '<string>',
'LastSuccessfulProvisioningRecordId' => '<string>',
'Name' => '<string>',
'PhysicalId' => '<string>',
'ProductId' => '<string>',
'ProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ProvisioningArtifactName' => '<string>',
'Status' => 'AVAILABLE|UNDER_CHANGE|TAINTED|ERROR|PLAN_IN_PROGRESS',
'StatusMessage' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'Type' => '<string>',
'UserArn' => '<string>',
'UserArnSession' => '<string>',
],
// ...
],
'TotalResultsCount' => <integer>,
]
Result Details
Members
- NextPageToken
-
- Type: string
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
- ProvisionedProducts
-
- Type: Array of ProvisionedProductAttribute structures
Information about the provisioned products.
- TotalResultsCount
-
- Type: int
The number of provisioned products found.
Errors
-
One or more parameters provided to the operation are not valid.
TerminateProvisionedProduct
$result = $client->terminateProvisionedProduct([/* ... */]); $promise = $client->terminateProvisionedProductAsync([/* ... */]);
Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
Parameter Syntax
$result = $client->terminateProvisionedProduct([
'AcceptLanguage' => '<string>',
'IgnoreErrors' => true || false,
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'RetainPhysicalResources' => true || false,
'TerminateToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IgnoreErrors
-
- Type: boolean
If set to true, Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
- ProvisionedProductId
-
- Type: string
The identifier of the provisioned product. You cannot specify both
ProvisionedProductNameandProvisionedProductId. - ProvisionedProductName
-
- Type: string
The name of the provisioned product. You cannot specify both
ProvisionedProductNameandProvisionedProductId. - RetainPhysicalResources
-
- Type: boolean
When this boolean parameter is set to true, the
TerminateProvisionedProductAPI 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. - TerminateToken
-
- Required: Yes
- Type: string
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
Information about the result of this request.
Errors
-
The specified resource was not found.
UpdateConstraint
$result = $client->updateConstraint([/* ... */]); $promise = $client->updateConstraintAsync([/* ... */]);
Updates the specified constraint.
Parameter Syntax
$result = $client->updateConstraint([
'AcceptLanguage' => '<string>',
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'Parameters' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Description
-
- Type: string
The updated description of the constraint.
- Id
-
- Required: Yes
- Type: string
The identifier of the constraint.
- Parameters
-
- Type: string
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
- LAUNCH
-
You are required to specify either the
RoleArnor theLocalRoleNamebut can't use both.Specify the
RoleArnproperty as follows:{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}Specify the
LocalRoleNameproperty as follows:{"LocalRoleName": "SCBasicLaunchRole"}If you specify the
LocalRoleNameproperty, 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
LAUNCHand aSTACKSETconstraint.You also cannot have more than one
LAUNCHconstraint on a product and portfolio. - NOTIFICATION
-
Specify the
NotificationArnsproperty as follows:{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]} - RESOURCE_UPDATE
-
Specify the
TagUpdatesOnProvisionedProductproperty as follows:{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}The
TagUpdatesOnProvisionedProductproperty accepts a string value ofALLOWEDorNOT_ALLOWED. - STACKSET
-
Specify the
Parametersproperty as follows:{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}You cannot have both a
LAUNCHand aSTACKSETconstraint.You also cannot have more than one
STACKSETconstraint on a product and portfolio.Products with a
STACKSETconstraint will launch an CloudFormation stack set. - TEMPLATE
-
Specify the
Rulesproperty. For more information, see Template Constraint Rules.
Result Syntax
[
'ConstraintDetail' => [
'ConstraintId' => '<string>',
'Description' => '<string>',
'Owner' => '<string>',
'PortfolioId' => '<string>',
'ProductId' => '<string>',
'Type' => '<string>',
],
'ConstraintParameters' => '<string>',
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- ConstraintDetail
-
- Type: ConstraintDetail structure
Information about the constraint.
- ConstraintParameters
-
- Type: string
The constraint parameters.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
UpdatePortfolio
$result = $client->updatePortfolio([/* ... */]); $promise = $client->updatePortfolioAsync([/* ... */]);
Updates the specified portfolio.
You cannot update a product that was shared with you.
Parameter Syntax
$result = $client->updatePortfolio([
'AcceptLanguage' => '<string>',
'AddTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>', // REQUIRED
'ProviderName' => '<string>',
'RemoveTags' => ['<string>', ...],
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AddTags
-
- Type: Array of Tag structures
The tags to add.
- Description
-
- Type: string
The updated description of the portfolio.
- DisplayName
-
- Type: string
The name to use for display purposes.
- Id
-
- Required: Yes
- Type: string
The portfolio identifier.
- ProviderName
-
- Type: string
The updated name of the portfolio provider.
- RemoveTags
-
- Type: Array of strings
The tags to remove.
Result Syntax
[
'PortfolioDetail' => [
'ARN' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'DisplayName' => '<string>',
'Id' => '<string>',
'ProviderName' => '<string>',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- PortfolioDetail
-
- Type: PortfolioDetail structure
Information about the portfolio.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the portfolio.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
UpdatePortfolioShare
$result = $client->updatePortfolioShare([/* ... */]); $promise = $client->updatePortfolioShareAsync([/* ... */]);
Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.
The portfolio share cannot be updated if the CreatePortfolioShare operation is IN_PROGRESS, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be COMPLETED.
You must provide the accountId or organization node in the input, but not both.
If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke UpdatePortfolioShare separately for each share type.
This API cannot be used for removing the portfolio share. You must use DeletePortfolioShare API for that action.
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is not an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using PrincipalType as IAM. With this configuration, the PrincipalARN must already exist in the recipient account before it can be associated.
Parameter Syntax
$result = $client->updatePortfolioShare([
'AcceptLanguage' => '<string>',
'AccountId' => '<string>',
'OrganizationNode' => [
'Type' => 'ORGANIZATION|ORGANIZATIONAL_UNIT|ACCOUNT',
'Value' => '<string>',
],
'PortfolioId' => '<string>', // REQUIRED
'SharePrincipals' => true || false,
'ShareTagOptions' => true || false,
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AccountId
-
- Type: string
The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.
- OrganizationNode
-
- Type: OrganizationNode structure
Information about the organization node.
- PortfolioId
-
- Required: Yes
- Type: string
The unique identifier of the portfolio for which the share will be updated.
- SharePrincipals
-
- Type: boolean
A flag to enables or disables
Principalssharing in the portfolio. If this field is not provided, the current state of thePrincipalssharing on the portfolio share will not be modified. - ShareTagOptions
-
- Type: boolean
Enables or disables
TagOptionssharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.
Result Syntax
[
'PortfolioShareToken' => '<string>',
'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|ERROR',
]
Result Details
Members
- PortfolioShareToken
-
- Type: string
The token that tracks the status of the
UpdatePortfolioShareoperation for external account to account or organizational type sharing. - Status
-
- Type: string
The status of
UpdatePortfolioShareoperation. You can also obtain the operation status usingDescribePortfolioShareStatusAPI.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
OperationNotSupportedException:
The operation is not supported.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
UpdateProduct
$result = $client->updateProduct([/* ... */]); $promise = $client->updateProductAsync([/* ... */]);
Updates the specified product.
Parameter Syntax
$result = $client->updateProduct([
'AcceptLanguage' => '<string>',
'AddTags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Description' => '<string>',
'Distributor' => '<string>',
'Id' => '<string>', // REQUIRED
'Name' => '<string>',
'Owner' => '<string>',
'RemoveTags' => ['<string>', ...],
'SourceConnection' => [
'ConnectionParameters' => [ // REQUIRED
'CodeStar' => [
'ArtifactPath' => '<string>', // REQUIRED
'Branch' => '<string>', // REQUIRED
'ConnectionArn' => '<string>', // REQUIRED
'Repository' => '<string>', // REQUIRED
],
],
'Type' => 'CODESTAR',
],
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- AddTags
-
- Type: Array of Tag structures
The tags to add to the product.
- Description
-
- Type: string
The updated description of the product.
- Distributor
-
- Type: string
The updated distributor of the product.
- Id
-
- Required: Yes
- Type: string
The product identifier.
- Name
-
- Type: string
The updated product name.
- Owner
-
- Type: string
The updated owner of the product.
- RemoveTags
-
- Type: Array of strings
The tags to remove from the product.
- SourceConnection
-
- Type: SourceConnection structure
Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The
SourceConnectionparameter consists of the following sub-fields.-
Type -
ConnectionParamters
- SupportDescription
-
- Type: string
The updated support description for the product.
- SupportEmail
-
- Type: string
The updated support email for the product.
- SupportUrl
-
- Type: string
The updated support URL for the product.
Result Syntax
[
'ProductViewDetail' => [
'CreatedTime' => <DateTime>,
'ProductARN' => '<string>',
'ProductViewSummary' => [
'Distributor' => '<string>',
'HasDefaultPath' => true || false,
'Id' => '<string>',
'Name' => '<string>',
'Owner' => '<string>',
'ProductId' => '<string>',
'ShortDescription' => '<string>',
'SupportDescription' => '<string>',
'SupportEmail' => '<string>',
'SupportUrl' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE',
],
'SourceConnection' => [
'ConnectionParameters' => [
'CodeStar' => [
'ArtifactPath' => '<string>',
'Branch' => '<string>',
'ConnectionArn' => '<string>',
'Repository' => '<string>',
],
],
'LastSync' => [
'LastSuccessfulSyncProvisioningArtifactId' => '<string>',
'LastSuccessfulSyncTime' => <DateTime>,
'LastSyncStatus' => 'SUCCEEDED|FAILED',
'LastSyncStatusMessage' => '<string>',
'LastSyncTime' => <DateTime>,
],
'Type' => 'CODESTAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
],
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- ProductViewDetail
-
- Type: ProductViewDetail structure
Information about the product view.
- Tags
-
- Type: Array of Tag structures
Information about the tags associated with the product.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
UpdateProvisionedProduct
$result = $client->updateProvisionedProduct([/* ... */]); $promise = $client->updateProvisionedProductAsync([/* ... */]);
Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
Parameter Syntax
$result = $client->updateProvisionedProduct([
'AcceptLanguage' => '<string>',
'PathId' => '<string>',
'PathName' => '<string>',
'ProductId' => '<string>',
'ProductName' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisioningArtifactId' => '<string>',
'ProvisioningArtifactName' => '<string>',
'ProvisioningParameters' => [
[
'Key' => '<string>',
'UsePreviousValue' => true || false,
'Value' => '<string>',
],
// ...
],
'ProvisioningPreferences' => [
'StackSetAccounts' => ['<string>', ...],
'StackSetFailureToleranceCount' => <integer>,
'StackSetFailureTolerancePercentage' => <integer>,
'StackSetMaxConcurrencyCount' => <integer>,
'StackSetMaxConcurrencyPercentage' => <integer>,
'StackSetOperationType' => 'CREATE|UPDATE|DELETE',
'StackSetRegions' => ['<string>', ...],
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'UpdateToken' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- PathId
-
- Type: string
The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.
- PathName
-
- Type: string
The name of the path. You must provide the name or ID, but not both.
- ProductId
-
- Type: string
The identifier of the product. You must provide the name or ID, but not both.
- ProductName
-
- Type: string
The name of the product. You must provide the name or ID, but not both.
- ProvisionedProductId
-
- Type: string
The identifier of the provisioned product. You must provide the name or ID, but not both.
- ProvisionedProductName
-
- Type: string
The name of the provisioned product. You cannot specify both
ProvisionedProductNameandProvisionedProductId. - ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
- ProvisioningArtifactName
-
- Type: string
The name of the provisioning artifact. You must provide the name or ID, but not both.
- ProvisioningParameters
-
- Type: Array of UpdateProvisioningParameter structures
The new parameters.
- ProvisioningPreferences
-
- Type: UpdateProvisioningPreferences structure
An object that contains information about the provisioning preferences for a stack set.
- Tags
-
- Type: Array of Tag structures
One or more tags. Requires the product to have
RESOURCE_UPDATEconstraint withTagUpdatesOnProvisionedProductset toALLOWEDto allow tag updates. - UpdateToken
-
- Required: Yes
- Type: string
The idempotency token that uniquely identifies the provisioning update request.
Result Syntax
[
'RecordDetail' => [
'CreatedTime' => <DateTime>,
'LaunchRoleArn' => '<string>',
'PathId' => '<string>',
'ProductId' => '<string>',
'ProvisionedProductId' => '<string>',
'ProvisionedProductName' => '<string>',
'ProvisionedProductType' => '<string>',
'ProvisioningArtifactId' => '<string>',
'RecordErrors' => [
[
'Code' => '<string>',
'Description' => '<string>',
],
// ...
],
'RecordId' => '<string>',
'RecordTags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'RecordType' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
'UpdatedTime' => <DateTime>,
],
]
Result Details
Members
- RecordDetail
-
- Type: RecordDetail structure
Information about the result of the request.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
UpdateProvisionedProductProperties
$result = $client->updateProvisionedProductProperties([/* ... */]); $promise = $client->updateProvisionedProductPropertiesAsync([/* ... */]);
Requests updates to the properties of the specified provisioned product.
Parameter Syntax
$result = $client->updateProvisionedProductProperties([
'AcceptLanguage' => '<string>',
'IdempotencyToken' => '<string>', // REQUIRED
'ProvisionedProductId' => '<string>', // REQUIRED
'ProvisionedProductProperties' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- IdempotencyToken
-
- Required: Yes
- Type: string
The idempotency token that uniquely identifies the provisioning product update request.
- ProvisionedProductId
-
- Required: Yes
- Type: string
The identifier of the provisioned product.
- ProvisionedProductProperties
-
- Required: Yes
- Type: Associative array of custom strings keys (PropertyKey) to strings
A map that contains the provisioned product properties to be updated.
The
LAUNCH_ROLEkey accepts role ARNs. This key allows an administrator to callUpdateProvisionedProductPropertiesto update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such asUpdateProvisionedProduct,TerminateProvisionedProduct, orExecuteProvisionedProductServiceAction. Only a role ARN is valid. A user ARN is invalid.The
OWNERkey accepts IAM user ARNs, IAM role ARNs, and STS assumed-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 or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the
ListRecordHistoryAPI. The new owner can describe all past records for the provisioned product using theDescribeRecordAPI. The previous owner can no longer useDescribeRecord, but can still see the product's history from when he was an owner usingListRecordHistory.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.
Result Syntax
[
'ProvisionedProductId' => '<string>',
'ProvisionedProductProperties' => ['<string>', ...],
'RecordId' => '<string>',
'Status' => 'CREATED|IN_PROGRESS|IN_PROGRESS_IN_ERROR|SUCCEEDED|FAILED',
]
Result Details
Members
- ProvisionedProductId
-
- Type: string
The provisioned product identifier.
- ProvisionedProductProperties
-
- Type: Associative array of custom strings keys (PropertyKey) to strings
A map that contains the properties updated.
- RecordId
-
- Type: string
The identifier of the record.
- Status
-
- Type: string
The status of the request.
Errors
-
One or more parameters provided to the operation are not valid.
-
The specified resource was not found.
-
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
UpdateProvisioningArtifact
$result = $client->updateProvisioningArtifact([/* ... */]); $promise = $client->updateProvisioningArtifactAsync([/* ... */]);
Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
Parameter Syntax
$result = $client->updateProvisioningArtifact([
'AcceptLanguage' => '<string>',
'Active' => true || false,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Name' => '<string>',
'ProductId' => '<string>', // REQUIRED
'ProvisioningArtifactId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Active
-
- Type: boolean
Indicates whether the product version is active.
Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
- Description
-
- Type: string
The updated description of the provisioning artifact.
- Guidance
-
- Type: string
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
The
DEFAULTvalue indicates that the product version is active.The administrator can set the guidance to
DEPRECATEDto 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. - Name
-
- Type: string
The updated name of the provisioning artifact.
- ProductId
-
- Required: Yes
- Type: string
The product identifier.
- ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact.
Result Syntax
[
'Info' => ['<string>', ...],
'ProvisioningArtifactDetail' => [
'Active' => true || false,
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Guidance' => 'DEFAULT|DEPRECATED',
'Id' => '<string>',
'Name' => '<string>',
'SourceRevision' => '<string>',
'Type' => 'CLOUD_FORMATION_TEMPLATE|MARKETPLACE_AMI|MARKETPLACE_CAR',
],
'Status' => 'AVAILABLE|CREATING|FAILED',
]
Result Details
Members
- Info
-
- Type: Associative array of custom strings keys (ProvisioningArtifactInfoKey) to strings
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
- ProvisioningArtifactDetail
-
- Type: ProvisioningArtifactDetail structure
Information about the provisioning artifact.
- Status
-
- Type: string
The status of the current request.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
UpdateServiceAction
$result = $client->updateServiceAction([/* ... */]); $promise = $client->updateServiceActionAsync([/* ... */]);
Updates a self-service action.
Parameter Syntax
$result = $client->updateServiceAction([
'AcceptLanguage' => '<string>',
'Definition' => ['<string>', ...],
'Description' => '<string>',
'Id' => '<string>', // REQUIRED
'Name' => '<string>',
]);
Parameter Details
Members
- AcceptLanguage
-
- Type: string
The language code.
-
en- English (default) -
jp- Japanese -
zh- Chinese
- Definition
-
- Type: Associative array of custom strings keys (ServiceActionDefinitionKey) to strings
A map that defines the self-service action.
- Description
-
- Type: string
The self-service action description.
- Id
-
- Required: Yes
- Type: string
The self-service action identifier.
- Name
-
- Type: string
The self-service action name.
Result Syntax
[
'ServiceActionDetail' => [
'Definition' => ['<string>', ...],
'ServiceActionSummary' => [
'DefinitionType' => 'SSM_AUTOMATION',
'Description' => '<string>',
'Id' => '<string>',
'Name' => '<string>',
],
],
]
Result Details
Members
- ServiceActionDetail
-
- Type: ServiceActionDetail structure
Detailed information about the self-service action.
Errors
-
The specified resource was not found.
-
One or more parameters provided to the operation are not valid.
UpdateTagOption
$result = $client->updateTagOption([/* ... */]); $promise = $client->updateTagOptionAsync([/* ... */]);
Updates the specified TagOption.
Parameter Syntax
$result = $client->updateTagOption([
'Active' => true || false,
'Id' => '<string>', // REQUIRED
'Value' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'TagOptionDetail' => [
'Active' => true || false,
'Id' => '<string>',
'Key' => '<string>',
'Owner' => '<string>',
'Value' => '<string>',
],
]
Result Details
Members
- TagOptionDetail
-
- Type: TagOptionDetail structure
Information about the TagOption.
Errors
-
TagOptionNotMigratedException:
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
-
The specified resource was not found.
-
The specified resource is a duplicate.
-
One or more parameters provided to the operation are not valid.
Shapes
AccessLevelFilter
Description
The access level to use to filter results.
Members
- Key
-
- Type: string
The access level.
-
Account- Filter results based on the account. -
Role- Filter results based on the federated role of the specified user. -
User- Filter results based on the specified user.
- Value
-
- Type: string
The user to which the access level applies. The only supported value is
Self.
BudgetDetail
Description
Information about a budget.
Members
CloudWatchDashboard
Description
Information about a CloudWatch dashboard.
Members
CodeStarParameters
Description
The subtype containing details about the Codestar connection Type.
Members
- ArtifactPath
-
- Required: Yes
- Type: string
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
- Branch
-
- Required: Yes
- Type: string
The specific branch where the artifact resides.
- ConnectionArn
-
- Required: Yes
- Type: string
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
- Repository
-
- Required: Yes
- Type: string
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
ConstraintDetail
Description
Information about a constraint.
Members
- ConstraintId
-
- Type: string
The identifier of the constraint.
- Description
-
- Type: string
The description of the constraint.
- Owner
-
- Type: string
The owner of the constraint.
- PortfolioId
-
- Type: string
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
- ProductId
-
- Type: string
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
- Type
-
- Type: string
The type of constraint.
-
LAUNCH -
NOTIFICATION -
STACKSET
-
TEMPLATE
ConstraintSummary
Description
Summary information about a constraint.
Members
DuplicateResourceException
Description
The specified resource is a duplicate.
Members
ExecutionParameter
Description
Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.
Members
FailedServiceActionAssociation
Description
An object containing information about the error, along with identifying information about the self-service action and its associations.
Members
- ErrorCode
-
- Type: string
The error code. Valid values are listed below.
- ErrorMessage
-
- Type: string
A text description of the error.
- ProductId
-
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne. - ServiceActionId
-
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
InvalidParametersException
Description
One or more parameters provided to the operation are not valid.
Members
InvalidStateException
Description
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.
Members
LastSync
Description
Provides details about the product's connection sync and contains the following sub-fields.
-
LastSyncTime -
LastSyncStatus -
LastSyncStatusMessage -
LastSuccessfulSyncTime -
LastSuccessfulSyncProvisioningArtifactID
Members
- LastSuccessfulSyncProvisioningArtifactId
-
- Type: string
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.
- LastSuccessfulSyncTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the latest successful sync from the source repo artifact to the Service Catalog product.
- LastSyncStatus
-
- Type: string
The current status of the sync. Responses include
SUCCEEDEDorFAILED. - LastSyncStatusMessage
-
- Type: string
The sync's status message.
- LastSyncTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time of the last attempted sync from the repository to the Service Catalog product.
LaunchPath
Description
A launch path object.
Members
LaunchPathSummary
Description
Summary information about a product path for a user.
Members
- ConstraintSummaries
-
- Type: Array of ConstraintSummary structures
The constraints on the portfolio-product relationship.
- Id
-
- Type: string
The identifier of the product path.
- Name
-
- Type: string
The name of the portfolio that contains the product.
- Tags
-
- Type: Array of Tag structures
The tags associated with this product path.
LimitExceededException
Description
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.
Members
ListRecordHistorySearchFilter
Description
The search filter to use when listing history records.
Members
ListTagOptionsFilters
Description
Filters to use when listing TagOptions.
Members
OperationNotSupportedException
Description
The operation is not supported.
Members
OrganizationNode
Description
Information about the organization node.
Members
ParameterConstraints
Description
The constraints that the administrator has put on the parameter.
Members
- AllowedPattern
-
- Type: string
A regular expression that represents the patterns that allow for
Stringtypes. The pattern must match the entire parameter value provided. - AllowedValues
-
- Type: Array of strings
The values that the administrator has allowed for the parameter.
- ConstraintDescription
-
- Type: string
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of
[A-Za-z0-9]+displays the following error message when the user specifies an invalid value:Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers. - MaxLength
-
- Type: string
An integer value that determines the largest number of characters you want to allow for
Stringtypes. - MaxValue
-
- Type: string
A numeric value that determines the largest numeric value you want to allow for
Numbertypes. - MinLength
-
- Type: string
An integer value that determines the smallest number of characters you want to allow for
Stringtypes. - MinValue
-
- Type: string
A numeric value that determines the smallest numeric value you want to allow for
Numbertypes.
PortfolioDetail
Description
Information about a portfolio.
Members
- ARN
-
- Type: string
The ARN assigned to the portfolio.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Description
-
- Type: string
The description of the portfolio.
- DisplayName
-
- Type: string
The name to use for display purposes.
- Id
-
- Type: string
The portfolio identifier.
- ProviderName
-
- Type: string
The name of the portfolio provider.
PortfolioShareDetail
Description
Information about the portfolio share.
Members
- Accepted
-
- Type: boolean
Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.
- PrincipalId
-
- Type: string
The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:
1. An external account.
2. An organziation member account.
3. An organzational unit (OU).
4. The organization itself. (This shares with every account in the organization).
- SharePrincipals
-
- Type: boolean
Indicates if
Principalsharing is enabled or disabled for the portfolio share. - ShareTagOptions
-
- Type: boolean
Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
- Type
-
- Type: string
The type of the portfolio share.
Principal
Description
Information about a principal.
Members
- PrincipalARN
-
- Type: string
The ARN of the principal (IAM user, role, or group). This field allows for an ARN with no
accountIDif thePrincipalTypeis anIAM_PATTERN. - PrincipalType
-
- Type: string
The principal type. The supported value is
IAMif you use a fully defined ARN, orIAM_PATTERNif you use an ARN with noaccountID.
ProductViewAggregationValue
Description
A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
Members
ProductViewDetail
Description
Information about a product view.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- ProductARN
-
- Type: string
The ARN of the product.
- ProductViewSummary
-
- Type: ProductViewSummary structure
Summary information about the product view.
- SourceConnection
-
- Type: SourceConnectionDetail structure
A top level
ProductViewDetailresponse containing details about the product’s connection. Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse. - Status
-
- Type: string
The status of the product.
-
AVAILABLE- The product is ready for use. -
CREATING- Product creation has started; the product is not ready for use. -
FAILED- An action failed.
ProductViewSummary
Description
Summary information about a product view.
Members
- Distributor
-
- Type: string
The distributor of the product. Contact the product administrator for the significance of this value.
- HasDefaultPath
-
- Type: boolean
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.
- Id
-
- Type: string
The product view identifier.
- Name
-
- Type: string
The name of the product.
- Owner
-
- Type: string
The owner of the product. Contact the product administrator for the significance of this value.
- ProductId
-
- Type: string
The product identifier.
- ShortDescription
-
- Type: string
Short description of the product.
- SupportDescription
-
- Type: string
The description of the support for this Product.
- SupportEmail
-
- Type: string
The email contact information to obtain support for this Product.
- SupportUrl
-
- Type: string
The URL information to obtain support for this Product.
- Type
-
- Type: string
The product type. Contact the product administrator for the significance of this value. If this value is
MARKETPLACE, the product was created by Amazon Web Services Marketplace.
ProvisionedProductAttribute
Description
Information about a provisioned product.
Members
- Arn
-
- Type: string
The ARN of the provisioned product.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Id
-
- Type: string
The identifier of the provisioned product.
- IdempotencyToken
-
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- LastProvisioningRecordId
-
- Type: string
The record identifier of the last request performed on this provisioned product of the following types:
-
ProvisionedProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- LastRecordId
-
- Type: string
The record identifier of the last request performed on this provisioned product.
- LastSuccessfulProvisioningRecordId
-
- Type: string
The record identifier of the last successful request performed on this provisioned product of the following types:
-
ProvisionedProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- Name
-
- Type: string
The user-friendly name of the provisioned product.
- PhysicalId
-
- Type: string
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
- ProductId
-
- Type: string
The product identifier.
- ProductName
-
- Type: string
The name of the product.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
- ProvisioningArtifactName
-
- Type: string
The name of the provisioning artifact.
- Status
-
- Type: string
The current status of the provisioned product.
-
AVAILABLE- Stable state, ready to perform any operation. The most recent operation succeeded and completed. -
UNDER_CHANGE- Transitive state. Operations performed might not have valid results. Wait for anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
- StatusMessage
-
- Type: string
The current status message of the provisioned product.
- Tags
-
- Type: Array of Tag structures
One or more tags.
- Type
-
- Type: string
The type of provisioned product. The supported values are
CFN_STACKandCFN_STACKSET. - UserArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM user.
- UserArnSession
-
- Type: string
The ARN of the IAM user in the session. This ARN might contain a session ID.
ProvisionedProductDetail
Description
Information about a provisioned product.
Members
- Arn
-
- Type: string
The ARN of the provisioned product.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Id
-
- Type: string
The identifier of the provisioned product.
- IdempotencyToken
-
- Type: string
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
- LastProvisioningRecordId
-
- Type: string
The record identifier of the last request performed on this provisioned product of the following types:
-
ProvisionedProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- LastRecordId
-
- Type: string
The record identifier of the last request performed on this provisioned product.
- LastSuccessfulProvisioningRecordId
-
- Type: string
The record identifier of the last successful request performed on this provisioned product of the following types:
-
ProvisionedProduct
-
UpdateProvisionedProduct
-
ExecuteProvisionedProductPlan
-
TerminateProvisionedProduct
- LaunchRoleArn
-
- Type: string
The ARN of the launch role associated with the provisioned product.
- Name
-
- Type: string
The user-friendly name of the provisioned product.
- ProductId
-
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne. - Status
-
- Type: string
The current status of the provisioned product.
-
AVAILABLE- Stable state, ready to perform any operation. The most recent operation succeeded and completed. -
UNDER_CHANGE- Transitive state. Operations performed might not have valid results. Wait for anAVAILABLEstatus 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 anAVAILABLEstatus before performing operations.
- StatusMessage
-
- Type: string
The current status message of the provisioned product.
- Type
-
- Type: string
The type of provisioned product. The supported values are
CFN_STACKandCFN_STACKSET.
ProvisionedProductPlanDetails
Description
Information about a plan.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- NotificationArns
-
- Type: Array of strings
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
- PathId
-
- Type: string
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
- PlanId
-
- Type: string
The plan identifier.
- PlanName
-
- Type: string
The name of the plan.
- PlanType
-
- Type: string
The plan type.
- ProductId
-
- Type: string
The product identifier.
- ProvisionProductId
-
- Type: string
The product identifier.
- ProvisionProductName
-
- Type: string
The user-friendly name of the provisioned product.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
- ProvisioningParameters
-
- Type: Array of UpdateProvisioningParameter structures
Parameters specified by the administrator that are required for provisioning the product.
- Status
-
- Type: string
The status.
- StatusMessage
-
- Type: string
The status message.
- Tags
-
- Type: Array of Tag structures
One or more tags.
- UpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp when the plan was last updated.
ProvisionedProductPlanSummary
Description
Summary information about a plan.
Members
- PlanId
-
- Type: string
The plan identifier.
- PlanName
-
- Type: string
The name of the plan.
- PlanType
-
- Type: string
The plan type.
- ProvisionProductId
-
- Type: string
The product identifier.
- ProvisionProductName
-
- Type: string
The user-friendly name of the provisioned product.
- ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
ProvisioningArtifact
Description
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Description
-
- Type: string
The description of the provisioning artifact.
- Guidance
-
- Type: string
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
- Id
-
- Type: string
The identifier of the provisioning artifact.
- Name
-
- Type: string
The name of the provisioning artifact.
ProvisioningArtifactDetail
Description
Information about a provisioning artifact (also known as a version) for a product.
Members
- Active
-
- Type: boolean
Indicates whether the product version is active.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Description
-
- Type: string
The description of the provisioning artifact.
- Guidance
-
- Type: string
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
- Id
-
- Type: string
The identifier of the provisioning artifact.
- Name
-
- Type: string
The name of the provisioning artifact.
- SourceRevision
-
- Type: string
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing
ProvisioningArtifactDetailtype, which is returned as part of the response forCreateProduct,UpdateProduct,DescribeProductAsAdmin,DescribeProvisioningArtifact,ListProvisioningArtifact, andUpdateProvisioningArticatAPIs.This field only exists for Repo-Synced products.
- Type
-
- Type: string
The type of provisioning artifact.
-
CLOUD_FORMATION_TEMPLATE- CloudFormation template -
MARKETPLACE_AMI- Amazon Web Services Marketplace AMI -
MARKETPLACE_CAR- Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
ProvisioningArtifactOutput
Description
Provisioning artifact output.
Members
ProvisioningArtifactParameter
Description
Information about a parameter used to provision a product.
Members
- DefaultValue
-
- Type: string
The default value.
- Description
-
- Type: string
The description of the parameter.
- IsNoEcho
-
- Type: boolean
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
- ParameterConstraints
-
- Type: ParameterConstraints structure
Constraints that the administrator has put on a parameter.
- ParameterKey
-
- Type: string
The parameter key.
- ParameterType
-
- Type: string
The parameter type.
ProvisioningArtifactPreferences
Description
The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the CloudFormation User Guide.
Members
- StackSetAccounts
-
- Type: Array of strings
One or more Amazon Web Services accounts where stack instances are deployed from the stack set. These accounts can be scoped in
ProvisioningPreferences$StackSetAccountsandUpdateProvisioningPreferences$StackSetAccounts.Applicable only to a
CFN_STACKSETprovisioned product type. - StackSetRegions
-
- Type: Array of strings
One or more Amazon Web Services Regions where stack instances are deployed from the stack set. These Regions can be scoped in
ProvisioningPreferences$StackSetRegionsandUpdateProvisioningPreferences$StackSetRegions.Applicable only to a
CFN_STACKSETprovisioned product type.
ProvisioningArtifactProperties
Description
Information about a provisioning artifact (also known as a version) for a product.
Members
- Description
-
- Type: string
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
- DisableTemplateValidation
-
- Type: boolean
If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.
- Info
-
- Type: Associative array of custom strings keys (ProvisioningArtifactInfoKey) to strings
Specify the template source with one of the following options, but not both. Keys accepted: [
LoadTemplateFromURL,ImportFromPhysicalId]The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows:ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId] - Name
-
- Type: string
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
- Type
-
- Type: string
The type of provisioning artifact.
-
CLOUD_FORMATION_TEMPLATE- CloudFormation template -
MARKETPLACE_AMI- Amazon Web Services Marketplace AMI -
MARKETPLACE_CAR- Amazon Web Services Marketplace Clusters and Amazon Web Services Resources
ProvisioningArtifactSummary
Description
Summary information about a provisioning artifact (also known as a version) for a product.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- Description
-
- Type: string
The description of the provisioning artifact.
- Id
-
- Type: string
The identifier of the provisioning artifact.
- Name
-
- Type: string
The name of the provisioning artifact.
- ProvisioningArtifactMetadata
-
- Type: Associative array of custom strings keys (ProvisioningArtifactInfoKey) to strings
The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.
ProvisioningArtifactView
Description
An object that contains summary information about a product view and a provisioning artifact.
Members
- ProductViewSummary
-
- Type: ProductViewSummary structure
Summary information about a product view.
- ProvisioningArtifact
-
- Type: ProvisioningArtifact structure
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
ProvisioningParameter
Description
Information about a parameter used to provision a product.
Members
ProvisioningPreferences
Description
The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type
One or more Amazon Web Services accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET provisioned product type.
The Amazon Web Services 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.
Members
- StackSetAccounts
-
- Type: Array of strings
One or more Amazon Web Services accounts where the provisioned product will be available.
Applicable only to a
CFN_STACKSETprovisioned product type.The specified accounts should be within the list of accounts from the
STACKSETconstraint. To get the list of accounts in theSTACKSETconstraint, use theDescribeProvisioningParametersoperation.If no values are specified, the default value is all acounts from the
STACKSETconstraint. - StackSetFailureToleranceCount
-
- Type: int
The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.
Applicable only to a
CFN_STACKSETprovisioned product type.Conditional: You must specify either
StackSetFailureToleranceCountorStackSetFailureTolerancePercentage, but not both.The default value is
0if no value is specified. - StackSetFailureTolerancePercentage
-
- Type: int
The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.
Applicable only to a
CFN_STACKSETprovisioned product type.Conditional: You must specify either
StackSetFailureToleranceCountorStackSetFailureTolerancePercentage, but not both. - StackSetMaxConcurrencyCount
-
- Type: int
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
StackSetFailureToleranceCount.StackSetMaxConcurrentCountis at most one more than theStackSetFailureToleranceCount.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_STACKSETprovisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCountorStackSetMaxConcurrentPercentage, but not both. - StackSetMaxConcurrencyPercentage
-
- Type: int
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, 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, Service Catalog sets the number as
1instead.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_STACKSETprovisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCountorStackSetMaxConcurrentPercentage, but not both. - StackSetRegions
-
- Type: Array of strings
One or more Amazon Web Services Regions where the provisioned product will be available.
Applicable only to a
CFN_STACKSETprovisioned product type.The specified Regions should be within the list of Regions from the
STACKSETconstraint. To get the list of Regions in theSTACKSETconstraint, use theDescribeProvisioningParametersoperation.If no values are specified, the default value is all Regions from the
STACKSETconstraint.
RecordDetail
Description
Information about a request operation.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The UTC time stamp of the creation time.
- LaunchRoleArn
-
- Type: string
The ARN of the launch role associated with the provisioned product.
- PathId
-
- Type: string
The path identifier.
- ProductId
-
- Type: string
The product identifier.
- ProvisionedProductId
-
- Type: string
The identifier of the provisioned product.
- ProvisionedProductName
-
- Type: string
The user-friendly name of the provisioned product.
- ProvisionedProductType
-
- Type: string
The type of provisioned product. The supported values are
CFN_STACKandCFN_STACKSET. - ProvisioningArtifactId
-
- Type: string
The identifier of the provisioning artifact.
- RecordErrors
-
- Type: Array of RecordError structures
The errors that occurred.
- RecordId
-
- Type: string
The identifier of the record.
- RecordTags
-
- Type: Array of RecordTag structures
One or more tags.
- RecordType
-
- Type: string
The record type.
-
PROVISION_PRODUCT -
UPDATE_PROVISIONED_PRODUCT -
TERMINATE_PROVISIONED_PRODUCT
- Status
-
- Type: string
The status of the provisioned product.
-
CREATED- The request was created but the operation has not started. -
IN_PROGRESS- The requested operation is in progress. -
IN_PROGRESS_IN_ERROR- The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback. -
SUCCEEDED- The requested operation has successfully completed. -
FAILED- The requested operation has unsuccessfully completed. Investigate using the error messages returned.
- UpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the record was last updated.
RecordError
Description
The error code and description resulting from an operation.
Members
RecordOutput
Description
The output for 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.
Members
RecordTag
Description
Information about a tag, which is a key-value pair.
Members
ResourceChange
Description
Information about a resource change that will occur when a plan is executed.
Members
- Action
-
- Type: string
The change action.
- Details
-
- Type: Array of ResourceChangeDetail structures
Information about the resource changes.
- LogicalResourceId
-
- Type: string
The ID of the resource, as defined in the CloudFormation template.
- PhysicalResourceId
-
- Type: string
The ID of the resource, if it was already created.
- Replacement
-
- Type: string
If the change type is
Modify, indicates whether the existing resource is deleted and replaced with a new one. - ResourceType
-
- Type: string
The type of resource.
- Scope
-
- Type: Array of strings
The change scope.
ResourceChangeDetail
Description
Information about a change to a resource attribute.
Members
- CausingEntity
-
- Type: string
The ID of the entity that caused the change.
- Evaluation
-
- Type: string
For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.
- Target
-
- Type: ResourceTargetDefinition structure
Information about the resource attribute to be modified.
ResourceDetail
Description
Information about a resource.
Members
- ARN
-
- Type: string
The ARN of the resource.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time of the resource.
- Description
-
- Type: string
The description of the resource.
- Id
-
- Type: string
The identifier of the resource.
- Name
-
- Type: string
The name of the resource.
ResourceInUseException
Description
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.
Members
ResourceNotFoundException
Description
The specified resource was not found.
Members
ResourceTargetDefinition
Description
Information about a change to a resource attribute.
Members
- Attribute
-
- Type: string
The attribute to be changed.
- Name
-
- Type: string
If the attribute is
Properties, the value is the name of the property. Otherwise, the value is null. - RequiresRecreation
-
- Type: string
If the attribute is
Properties, indicates whether a change to this property causes the resource to be re-created.
ServiceActionAssociation
Description
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
Members
- ProductId
-
- Required: Yes
- Type: string
The product identifier. For example,
prod-abcdzk7xy33qa. - ProvisioningArtifactId
-
- Required: Yes
- Type: string
The identifier of the provisioning artifact. For example,
pa-4abcdjnxjj6ne. - ServiceActionId
-
- Required: Yes
- Type: string
The self-service action identifier. For example,
act-fs7abcd89wxyz.
ServiceActionDetail
Description
An object containing detailed information about the self-service action.
Members
- Definition
-
- Type: Associative array of custom strings keys (ServiceActionDefinitionKey) to strings
A map that defines the self-service action.
- ServiceActionSummary
-
- Type: ServiceActionSummary structure
Summary information about the self-service action.
ServiceActionSummary
Description
Detailed information about the self-service action.
Members
ShareDetails
Description
Information about the portfolio share operation.
Members
- ShareErrors
-
- Type: Array of ShareError structures
List of errors.
- SuccessfulShares
-
- Type: Array of strings
List of accounts for whom the operation succeeded.
ShareError
Description
Errors that occurred during the portfolio share operation.
Members
SourceConnection
Description
A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.
Members
- ConnectionParameters
-
- Required: Yes
- Type: SourceConnectionParameters structure
The connection details based on the connection
Type. - Type
-
- Type: string
The only supported
SourceConnectiontype is Codestar.
SourceConnectionDetail
Description
Provides details about the configured SourceConnection.
Members
- ConnectionParameters
-
- Type: SourceConnectionParameters structure
The connection details based on the connection
Type. - LastSync
-
- Type: LastSync structure
Provides details about the product's connection sync and contains the following sub-fields.
-
LastSyncTime -
LastSyncStatus -
LastSyncStatusMessage -
LastSuccessfulSyncTime -
LastSuccessfulSyncProvisioningArtifactID
- Type
-
- Type: string
The only supported
SourceConnectiontype is Codestar.
SourceConnectionParameters
Description
Provides connection details.
Members
- CodeStar
-
- Type: CodeStarParameters structure
Provides
ConnectionTypedetails.
StackInstance
Description
An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
Members
- Account
-
- Type: string
The name of the Amazon Web Services account that the stack instance is associated with.
- Region
-
- Type: string
The name of the Amazon Web Services Region that the stack instance is associated with.
- StackInstanceStatus
-
- Type: string
The status of the stack instance, in terms of its synchronization with its associated stack set.
-
INOPERABLE: ADeleteStackInstancesoperation has failed and left the stack in an unstable state. Stacks in this state are excluded from furtherUpdateStackSetoperations. You might need to perform aDeleteStackInstancesoperation, withRetainStacksset 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 aCreateStackSetorUpdateStackSetoperation, or the stack was part of aCreateStackSetorUpdateStackSetoperation that failed or was stopped before the stack was created or updated. -
CURRENT: The stack is currently up to date with the stack set.
Tag
Description
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Members
TagOptionDetail
Description
Information about a TagOption.
Members
TagOptionNotMigratedException
Description
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the Amazon Web Services Management Console to perform the migration process before retrying the operation.
Members
TagOptionSummary
Description
Summary information about a TagOption.
Members
UpdateProvisioningParameter
Description
The parameter key-value pair used to update a provisioned product.
Members
UpdateProvisioningPreferences
Description
The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.
Members
- StackSetAccounts
-
- Type: Array of strings
One or more Amazon Web Services accounts that will have access to the provisioned product.
Applicable only to a
CFN_STACKSETprovisioned product type.The Amazon Web Services accounts specified should be within the list of accounts in the
STACKSETconstraint. To get the list of accounts in theSTACKSETconstraint, use theDescribeProvisioningParametersoperation.If no values are specified, the default value is all accounts from the
STACKSETconstraint. - StackSetFailureToleranceCount
-
- Type: int
The number of accounts, per Region, for which this operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.
Applicable only to a
CFN_STACKSETprovisioned product type.Conditional: You must specify either
StackSetFailureToleranceCountorStackSetFailureTolerancePercentage, but not both.The default value is
0if no value is specified. - StackSetFailureTolerancePercentage
-
- Type: int
The percentage of accounts, per Region, for which this stack operation can fail before Service Catalog stops the operation in that Region. If the operation is stopped in a Region, Service Catalog doesn't attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, Service Catalog rounds down to the next whole number.
Applicable only to a
CFN_STACKSETprovisioned product type.Conditional: You must specify either
StackSetFailureToleranceCountorStackSetFailureTolerancePercentage, but not both. - StackSetMaxConcurrencyCount
-
- Type: int
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
StackSetFailureToleranceCount.StackSetMaxConcurrentCountis at most one more than theStackSetFailureToleranceCount.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_STACKSETprovisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCountorStackSetMaxConcurrentPercentage, but not both. - StackSetMaxConcurrencyPercentage
-
- Type: int
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, 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, Service Catalog sets the number as
1instead.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_STACKSETprovisioned product type.Conditional: You must specify either
StackSetMaxConcurrentCountorStackSetMaxConcurrentPercentage, but not both. - StackSetOperationType
-
- Type: string
Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is
UPDATEif nothing is specified.Applicable only to a
CFN_STACKSETprovisioned product type.- CREATE
-
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
- UPDATE
-
Updates the stack set represented by the provisioned product and also its stack instances.
- DELETE
-
Deletes a stack instance in the stack set represented by the provisioned product.
- StackSetRegions
-
- Type: Array of strings
One or more Amazon Web Services Regions where the provisioned product will be available.
Applicable only to a
CFN_STACKSETprovisioned product type.The specified Regions should be within the list of Regions from the
STACKSETconstraint. To get the list of Regions in theSTACKSETconstraint, use theDescribeProvisioningParametersoperation.If no values are specified, the default value is all Regions from the
STACKSETconstraint.