{ "version":"2.0", "metadata":{ "apiVersion":"2015-12-10", "endpointPrefix":"servicecatalog", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Service Catalog", "serviceId":"Service Catalog", "signatureVersion":"v4", "targetPrefix":"AWS242ServiceCatalogService", "uid":"servicecatalog-2015-12-10" }, "operations":{ "AcceptPortfolioShare":{ "name":"AcceptPortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptPortfolioShareInput"}, "output":{"shape":"AcceptPortfolioShareOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Accepts an offer to share the specified portfolio.

" }, "AssociateBudgetWithResource":{ "name":"AssociateBudgetWithResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateBudgetWithResourceInput"}, "output":{"shape":"AssociateBudgetWithResourceOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Associates the specified budget with the specified resource.

" }, "AssociatePrincipalWithPortfolio":{ "name":"AssociatePrincipalWithPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociatePrincipalWithPortfolioInput"}, "output":{"shape":"AssociatePrincipalWithPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "AssociateProductWithPortfolio":{ "name":"AssociateProductWithPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateProductWithPortfolioInput"}, "output":{"shape":"AssociateProductWithPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

" }, "AssociateServiceActionWithProvisioningArtifact":{ "name":"AssociateServiceActionWithProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateServiceActionWithProvisioningArtifactInput"}, "output":{"shape":"AssociateServiceActionWithProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Associates a self-service action with a provisioning artifact.

" }, "AssociateTagOptionWithResource":{ "name":"AssociateTagOptionWithResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateTagOptionWithResourceInput"}, "output":{"shape":"AssociateTagOptionWithResourceOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"}, {"shape":"DuplicateResourceException"}, {"shape":"InvalidStateException"} ], "documentation":"

Associate the specified TagOption with the specified portfolio or product.

" }, "BatchAssociateServiceActionWithProvisioningArtifact":{ "name":"BatchAssociateServiceActionWithProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchAssociateServiceActionWithProvisioningArtifactInput"}, "output":{"shape":"BatchAssociateServiceActionWithProvisioningArtifactOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Associates multiple self-service actions with provisioning artifacts.

" }, "BatchDisassociateServiceActionFromProvisioningArtifact":{ "name":"BatchDisassociateServiceActionFromProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDisassociateServiceActionFromProvisioningArtifactInput"}, "output":{"shape":"BatchDisassociateServiceActionFromProvisioningArtifactOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Disassociates a batch of self-service actions from the specified provisioning artifact.

" }, "CopyProduct":{ "name":"CopyProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyProductInput"}, "output":{"shape":"CopyProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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.

" }, "CreateConstraint":{ "name":"CreateConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConstraintInput"}, "output":{"shape":"CreateConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"}, {"shape":"DuplicateResourceException"} ], "documentation":"

Creates a constraint.

A delegated admin is authorized to invoke this command.

" }, "CreatePortfolio":{ "name":"CreatePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePortfolioInput"}, "output":{"shape":"CreatePortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

Creates a portfolio.

A delegated admin is authorized to invoke this command.

" }, "CreatePortfolioShare":{ "name":"CreatePortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePortfolioShareInput"}, "output":{"shape":"CreatePortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"}, {"shape":"InvalidStateException"} ], "documentation":"

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.

" }, "CreateProduct":{ "name":"CreateProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProductInput"}, "output":{"shape":"CreateProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

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.

" }, "CreateProvisionedProductPlan":{ "name":"CreateProvisionedProductPlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProvisionedProductPlanInput"}, "output":{"shape":"CreateProvisionedProductPlanOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"} ], "documentation":"

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.

" }, "CreateProvisioningArtifact":{ "name":"CreateProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProvisioningArtifactInput"}, "output":{"shape":"CreateProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"} ], "documentation":"

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.

" }, "CreateServiceAction":{ "name":"CreateServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServiceActionInput"}, "output":{"shape":"CreateServiceActionOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a self-service action.

" }, "CreateTagOption":{ "name":"CreateTagOption", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagOptionInput"}, "output":{"shape":"CreateTagOptionOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"DuplicateResourceException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a TagOption.

" }, "DeleteConstraint":{ "name":"DeleteConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConstraintInput"}, "output":{"shape":"DeleteConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

" }, "DeletePortfolio":{ "name":"DeletePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePortfolioInput"}, "output":{"shape":"DeletePortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ResourceInUseException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

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.

" }, "DeletePortfolioShare":{ "name":"DeletePortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePortfolioShareInput"}, "output":{"shape":"DeletePortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"}, {"shape":"InvalidStateException"} ], "documentation":"

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.

" }, "DeleteProduct":{ "name":"DeleteProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProductInput"}, "output":{"shape":"DeleteProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

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.

" }, "DeleteProvisionedProductPlan":{ "name":"DeleteProvisionedProductPlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProvisionedProductPlanInput"}, "output":{"shape":"DeleteProvisionedProductPlanOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the specified plan.

" }, "DeleteProvisioningArtifact":{ "name":"DeleteProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProvisioningArtifactInput"}, "output":{"shape":"DeleteProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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.

" }, "DeleteServiceAction":{ "name":"DeleteServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServiceActionInput"}, "output":{"shape":"DeleteServiceActionOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes a self-service action.

" }, "DeleteTagOption":{ "name":"DeleteTagOption", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagOptionInput"}, "output":{"shape":"DeleteTagOptionOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

" }, "DescribeConstraint":{ "name":"DescribeConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConstraintInput"}, "output":{"shape":"DescribeConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets information about the specified constraint.

" }, "DescribeCopyProductStatus":{ "name":"DescribeCopyProductStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCopyProductStatusInput"}, "output":{"shape":"DescribeCopyProductStatusOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets the status of the specified copy product operation.

" }, "DescribePortfolio":{ "name":"DescribePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePortfolioInput"}, "output":{"shape":"DescribePortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

" }, "DescribePortfolioShareStatus":{ "name":"DescribePortfolioShareStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePortfolioShareStatusInput"}, "output":{"shape":"DescribePortfolioShareStatusOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "DescribePortfolioShares":{ "name":"DescribePortfolioShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePortfolioSharesInput"}, "output":{"shape":"DescribePortfolioSharesOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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.

" }, "DescribeProduct":{ "name":"DescribeProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductInput"}, "output":{"shape":"DescribeProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the specified product.

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

" }, "DescribeProductAsAdmin":{ "name":"DescribeProductAsAdmin", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductAsAdminInput"}, "output":{"shape":"DescribeProductAsAdminOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the specified product. This operation is run with administrator access.

" }, "DescribeProductView":{ "name":"DescribeProductView", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductViewInput"}, "output":{"shape":"DescribeProductViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the specified product.

" }, "DescribeProvisionedProduct":{ "name":"DescribeProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisionedProductInput"}, "output":{"shape":"DescribeProvisionedProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the specified provisioned product.

" }, "DescribeProvisionedProductPlan":{ "name":"DescribeProvisionedProductPlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisionedProductPlanInput"}, "output":{"shape":"DescribeProvisionedProductPlanOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the resource changes for the specified plan.

" }, "DescribeProvisioningArtifact":{ "name":"DescribeProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisioningArtifactInput"}, "output":{"shape":"DescribeProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

" }, "DescribeProvisioningParameters":{ "name":"DescribeProvisioningParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisioningParametersInput"}, "output":{"shape":"DescribeProvisioningParametersOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

" }, "DescribeRecord":{ "name":"DescribeRecord", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRecordInput"}, "output":{"shape":"DescribeRecordOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "DescribeServiceAction":{ "name":"DescribeServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServiceActionInput"}, "output":{"shape":"DescribeServiceActionOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes a self-service action.

" }, "DescribeServiceActionExecutionParameters":{ "name":"DescribeServiceActionExecutionParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServiceActionExecutionParametersInput"}, "output":{"shape":"DescribeServiceActionExecutionParametersOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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":{ "name":"DescribeTagOption", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagOptionInput"}, "output":{"shape":"DescribeTagOptionOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets information about the specified TagOption.

" }, "DisableAWSOrganizationsAccess":{ "name":"DisableAWSOrganizationsAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableAWSOrganizationsAccessInput"}, "output":{"shape":"DisableAWSOrganizationsAccessOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "DisassociateBudgetFromResource":{ "name":"DisassociateBudgetFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateBudgetFromResourceInput"}, "output":{"shape":"DisassociateBudgetFromResourceOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates the specified budget from the specified resource.

" }, "DisassociatePrincipalFromPortfolio":{ "name":"DisassociatePrincipalFromPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociatePrincipalFromPortfolioInput"}, "output":{"shape":"DisassociatePrincipalFromPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

If you disassociate a principal from a portfolio, with PrincipalType as `IAM`, the same principal will still have access to the portfolio if it matches one of the associated principals of type `IAM_PATTERN`. To fully remove access for a principal, verify all the associated Principals of type `IAM_PATTERN`, and then ensure you disassociate any `IAM_PATTERN` principals that match the principal whose access you are removing.

" }, "DisassociateProductFromPortfolio":{ "name":"DisassociateProductFromPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateProductFromPortfolioInput"}, "output":{"shape":"DisassociateProductFromPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Disassociates the specified product from the specified portfolio.

A delegated admin is authorized to invoke this command.

" }, "DisassociateServiceActionFromProvisioningArtifact":{ "name":"DisassociateServiceActionFromProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateServiceActionFromProvisioningArtifactInput"}, "output":{"shape":"DisassociateServiceActionFromProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates the specified self-service action association from the specified provisioning artifact.

" }, "DisassociateTagOptionFromResource":{ "name":"DisassociateTagOptionFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateTagOptionFromResourceInput"}, "output":{"shape":"DisassociateTagOptionFromResourceOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates the specified TagOption from the specified resource.

" }, "EnableAWSOrganizationsAccess":{ "name":"EnableAWSOrganizationsAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableAWSOrganizationsAccessInput"}, "output":{"shape":"EnableAWSOrganizationsAccessOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "ExecuteProvisionedProductPlan":{ "name":"ExecuteProvisionedProductPlan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteProvisionedProductPlanInput"}, "output":{"shape":"ExecuteProvisionedProductPlanOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"} ], "documentation":"

Provisions or modifies a product based on the resource changes for the specified plan.

" }, "ExecuteProvisionedProductServiceAction":{ "name":"ExecuteProvisionedProductServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteProvisionedProductServiceActionInput"}, "output":{"shape":"ExecuteProvisionedProductServiceActionOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"} ], "documentation":"

Executes a self-service action against a provisioned product.

" }, "GetAWSOrganizationsAccessStatus":{ "name":"GetAWSOrganizationsAccessStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAWSOrganizationsAccessStatusInput"}, "output":{"shape":"GetAWSOrganizationsAccessStatusOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "GetProvisionedProductOutputs":{ "name":"GetProvisionedProductOutputs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetProvisionedProductOutputsInput"}, "output":{"shape":"GetProvisionedProductOutputsOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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":{ "name":"ImportAsProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportAsProvisionedProductInput"}, "output":{"shape":"ImportAsProvisionedProductOutput"}, "errors":[ {"shape":"DuplicateResourceException"}, {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints 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.

You can only import one provisioned product at a time. The product's CloudFormation stack must have the `IMPORT_COMPLETE` status before you import another.

" }, "ListAcceptedPortfolioShares":{ "name":"ListAcceptedPortfolioShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcceptedPortfolioSharesInput"}, "output":{"shape":"ListAcceptedPortfolioSharesOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "ListBudgetsForResource":{ "name":"ListBudgetsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBudgetsForResourceInput"}, "output":{"shape":"ListBudgetsForResourceOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all the budgets associated to the specified resource.

" }, "ListConstraintsForPortfolio":{ "name":"ListConstraintsForPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListConstraintsForPortfolioInput"}, "output":{"shape":"ListConstraintsForPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists the constraints for the specified portfolio and product.

" }, "ListLaunchPaths":{ "name":"ListLaunchPaths", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLaunchPathsInput"}, "output":{"shape":"ListLaunchPathsOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "ListOrganizationPortfolioAccess":{ "name":"ListOrganizationPortfolioAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOrganizationPortfolioAccessInput"}, "output":{"shape":"ListOrganizationPortfolioAccessOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"} ], "documentation":"

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.

" }, "ListPortfolioAccess":{ "name":"ListPortfolioAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfolioAccessInput"}, "output":{"shape":"ListPortfolioAccessOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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.

" }, "ListPortfolios":{ "name":"ListPortfolios", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfoliosInput"}, "output":{"shape":"ListPortfoliosOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists all portfolios in the catalog.

" }, "ListPortfoliosForProduct":{ "name":"ListPortfoliosForProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfoliosForProductInput"}, "output":{"shape":"ListPortfoliosForProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all portfolios that the specified product is associated with.

" }, "ListPrincipalsForPortfolio":{ "name":"ListPrincipalsForPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPrincipalsForPortfolioInput"}, "output":{"shape":"ListPrincipalsForPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all `PrincipalARN`s and corresponding `PrincipalType`s associated with the specified portfolio.

" }, "ListProvisionedProductPlans":{ "name":"ListProvisionedProductPlans", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProvisionedProductPlansInput"}, "output":{"shape":"ListProvisionedProductPlansOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists the plans for the specified provisioned product or all plans to which the user has access.

" }, "ListProvisioningArtifacts":{ "name":"ListProvisioningArtifacts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProvisioningArtifactsInput"}, "output":{"shape":"ListProvisioningArtifactsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all provisioning artifacts (also known as versions) for the specified product.

" }, "ListProvisioningArtifactsForServiceAction":{ "name":"ListProvisioningArtifactsForServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProvisioningArtifactsForServiceActionInput"}, "output":{"shape":"ListProvisioningArtifactsForServiceActionOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

" }, "ListRecordHistory":{ "name":"ListRecordHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRecordHistoryInput"}, "output":{"shape":"ListRecordHistoryOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists the specified requests or all performed requests.

" }, "ListResourcesForTagOption":{ "name":"ListResourcesForTagOption", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourcesForTagOptionInput"}, "output":{"shape":"ListResourcesForTagOptionOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists the resources associated with the specified TagOption.

" }, "ListServiceActions":{ "name":"ListServiceActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServiceActionsInput"}, "output":{"shape":"ListServiceActionsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists all self-service actions.

" }, "ListServiceActionsForProvisioningArtifact":{ "name":"ListServiceActionsForProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServiceActionsForProvisioningArtifactInput"}, "output":{"shape":"ListServiceActionsForProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

" }, "ListStackInstancesForProvisionedProduct":{ "name":"ListStackInstancesForProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStackInstancesForProvisionedProductInput"}, "output":{"shape":"ListStackInstancesForProvisionedProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "ListTagOptions":{ "name":"ListTagOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagOptionsInput"}, "output":{"shape":"ListTagOptionsOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists the specified TagOptions or all TagOptions.

" }, "NotifyProvisionProductEngineWorkflowResult":{ "name":"NotifyProvisionProductEngineWorkflowResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"NotifyProvisionProductEngineWorkflowResultInput"}, "output":{"shape":"NotifyProvisionProductEngineWorkflowResultOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Notifies the result of the provisioning engine execution.

" }, "NotifyTerminateProvisionedProductEngineWorkflowResult":{ "name":"NotifyTerminateProvisionedProductEngineWorkflowResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"NotifyTerminateProvisionedProductEngineWorkflowResultInput"}, "output":{"shape":"NotifyTerminateProvisionedProductEngineWorkflowResultOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Notifies the result of the terminate engine execution.

" }, "NotifyUpdateProvisionedProductEngineWorkflowResult":{ "name":"NotifyUpdateProvisionedProductEngineWorkflowResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"NotifyUpdateProvisionedProductEngineWorkflowResultInput"}, "output":{"shape":"NotifyUpdateProvisionedProductEngineWorkflowResultOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Notifies the result of the update engine execution.

" }, "ProvisionProduct":{ "name":"ProvisionProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ProvisionProductInput"}, "output":{"shape":"ProvisionProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DuplicateResourceException"} ], "documentation":"

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.

" }, "RejectPortfolioShare":{ "name":"RejectPortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectPortfolioShareInput"}, "output":{"shape":"RejectPortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Rejects an offer to share the specified portfolio.

" }, "ScanProvisionedProducts":{ "name":"ScanProvisionedProducts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScanProvisionedProductsInput"}, "output":{"shape":"ScanProvisionedProductsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists the provisioned products that are available (not terminated).

To use additional filtering, see SearchProvisionedProducts.

" }, "SearchProducts":{ "name":"SearchProducts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchProductsInput"}, "output":{"shape":"SearchProductsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the products to which the caller has access.

" }, "SearchProductsAsAdmin":{ "name":"SearchProductsAsAdmin", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchProductsAsAdminInput"}, "output":{"shape":"SearchProductsAsAdminOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the products for the specified portfolio or all products.

" }, "SearchProvisionedProducts":{ "name":"SearchProvisionedProducts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchProvisionedProductsInput"}, "output":{"shape":"SearchProvisionedProductsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Gets information about the provisioned products that meet the specified criteria.

" }, "TerminateProvisionedProduct":{ "name":"TerminateProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateProvisionedProductInput"}, "output":{"shape":"TerminateProvisionedProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "UpdateConstraint":{ "name":"UpdateConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateConstraintInput"}, "output":{"shape":"UpdateConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates the specified constraint.

" }, "UpdatePortfolio":{ "name":"UpdatePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePortfolioInput"}, "output":{"shape":"UpdatePortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

Updates the specified portfolio.

You cannot update a product that was shared with you.

" }, "UpdatePortfolioShare":{ "name":"UpdatePortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePortfolioShareInput"}, "output":{"shape":"UpdatePortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"OperationNotSupportedException"}, {"shape":"InvalidStateException"} ], "documentation":"

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.

" }, "UpdateProduct":{ "name":"UpdateProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProductInput"}, "output":{"shape":"UpdateProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"TagOptionNotMigratedException"} ], "documentation":"

Updates the specified product.

" }, "UpdateProvisionedProduct":{ "name":"UpdateProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProvisionedProductInput"}, "output":{"shape":"UpdateProvisionedProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "UpdateProvisionedProductProperties":{ "name":"UpdateProvisionedProductProperties", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProvisionedProductPropertiesInput"}, "output":{"shape":"UpdateProvisionedProductPropertiesOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"} ], "documentation":"

Requests updates to the properties of the specified provisioned product.

" }, "UpdateProvisioningArtifact":{ "name":"UpdateProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProvisioningArtifactInput"}, "output":{"shape":"UpdateProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

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.

" }, "UpdateServiceAction":{ "name":"UpdateServiceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceActionInput"}, "output":{"shape":"UpdateServiceActionOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates a self-service action.

" }, "UpdateTagOption":{ "name":"UpdateTagOption", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTagOptionInput"}, "output":{"shape":"UpdateTagOptionOutput"}, "errors":[ {"shape":"TagOptionNotMigratedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DuplicateResourceException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates the specified TagOption.

" } }, "shapes":{ "AcceptLanguage":{ "type":"string", "max":100 }, "AcceptPortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PortfolioShareType":{ "shape":"PortfolioShareType", "documentation":"

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`

" } } }, "AcceptPortfolioShareOutput":{ "type":"structure", "members":{ } }, "AccessLevelFilter":{ "type":"structure", "members":{ "Key":{ "shape":"AccessLevelFilterKey", "documentation":"

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":{ "shape":"AccessLevelFilterValue", "documentation":"

The user to which the access level applies. The only supported value is `self`.

" } }, "documentation":"

The access level to use to filter results.

" }, "AccessLevelFilterKey":{ "type":"string", "enum":[ "Account", "Role", "User" ] }, "AccessLevelFilterValue":{"type":"string"}, "AccessStatus":{ "type":"string", "enum":[ "ENABLED", "UNDER_CHANGE", "DISABLED" ] }, "AccountId":{ "type":"string", "pattern":"^[0-9]{12}$" }, "AccountIds":{ "type":"list", "member":{"shape":"AccountId"} }, "AddTags":{ "type":"list", "member":{"shape":"Tag"}, "max":20 }, "AllowedValues":{ "type":"list", "member":{"shape":"String"} }, "ApproximateCount":{"type":"integer"}, "AssociateBudgetWithResourceInput":{ "type":"structure", "required":[ "BudgetName", "ResourceId" ], "members":{ "BudgetName":{ "shape":"BudgetName", "documentation":"

The name of the budget you want to associate.

" }, "ResourceId":{ "shape":"Id", "documentation":"

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

" } } }, "AssociateBudgetWithResourceOutput":{ "type":"structure", "members":{ } }, "AssociatePrincipalWithPortfolioInput":{ "type":"structure", "required":[ "PortfolioId", "PrincipalARN", "PrincipalType" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

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

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

The ARN resource-id can be either:

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

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

  The ARN path and principal name allow unlimited wildcard characters.

Examples of an acceptable wildcard ARN:

- arn:aws:iam:::role/ResourceName_*

- arn:aws:iam:::role/*/ResourceName_?

Examples of an unacceptable wildcard ARN:

- arn:aws:iam:::*/ResourceName

You can associate multiple `IAM_PATTERN`s even if the account has no principal with that name.

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

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

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

" }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"

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

" } } }, "AssociatePrincipalWithPortfolioOutput":{ "type":"structure", "members":{ } }, "AssociateProductWithPortfolioInput":{ "type":"structure", "required":[ "ProductId", "PortfolioId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "SourcePortfolioId":{ "shape":"Id", "documentation":"

The identifier of the source portfolio.

" } } }, "AssociateProductWithPortfolioOutput":{ "type":"structure", "members":{ } }, "AssociateServiceActionWithProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId", "ServiceActionId" ], "members":{ "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", "idempotencyToken":true } } }, "AssociateServiceActionWithProvisioningArtifactOutput":{ "type":"structure", "members":{ } }, "AssociateTagOptionWithResourceInput":{ "type":"structure", "required":[ "ResourceId", "TagOptionId" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource identifier.

" }, "TagOptionId":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" } } }, "AssociateTagOptionWithResourceOutput":{ "type":"structure", "members":{ } }, "AttributeValue":{"type":"string"}, "BatchAssociateServiceActionWithProvisioningArtifactInput":{ "type":"structure", "required":["ServiceActionAssociations"], "members":{ "ServiceActionAssociations":{ "shape":"ServiceActionAssociations", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "BatchAssociateServiceActionWithProvisioningArtifactOutput":{ "type":"structure", "members":{ "FailedServiceActionAssociations":{ "shape":"FailedServiceActionAssociations", "documentation":"

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

" } } }, "BatchDisassociateServiceActionFromProvisioningArtifactInput":{ "type":"structure", "required":["ServiceActionAssociations"], "members":{ "ServiceActionAssociations":{ "shape":"ServiceActionAssociations", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "BatchDisassociateServiceActionFromProvisioningArtifactOutput":{ "type":"structure", "members":{ "FailedServiceActionAssociations":{ "shape":"FailedServiceActionAssociations", "documentation":"

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

" } } }, "Boolean":{"type":"boolean"}, "BudgetDetail":{ "type":"structure", "members":{ "BudgetName":{ "shape":"BudgetName", "documentation":"

Name of the associated budget.

" } }, "documentation":"

Information about a budget.

" }, "BudgetName":{ "type":"string", "max":100, "min":1 }, "Budgets":{ "type":"list", "member":{"shape":"BudgetDetail"} }, "CausingEntity":{"type":"string"}, "ChangeAction":{ "type":"string", "enum":[ "ADD", "MODIFY", "REMOVE" ] }, "CloudWatchDashboard":{ "type":"structure", "members":{ "Name":{ "shape":"CloudWatchDashboardName", "documentation":"

The name of the CloudWatch dashboard.

" } }, "documentation":"

Information about a CloudWatch dashboard.

" }, "CloudWatchDashboardName":{"type":"string"}, "CloudWatchDashboards":{ "type":"list", "member":{"shape":"CloudWatchDashboard"} }, "CodeStarConnectionArn":{ "type":"string", "max":1224, "min":1, "pattern":"arn:[a-z0-9][-.a-z0-9]{0,62}:codestar-connections:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:[^/].{0,1023}$" }, "CodeStarParameters":{ "type":"structure", "required":[ "ConnectionArn", "Repository", "Branch", "ArtifactPath" ], "members":{ "ConnectionArn":{ "shape":"CodeStarConnectionArn", "documentation":"

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

" }, "Repository":{ "shape":"Repository", "documentation":"

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

" }, "Branch":{ "shape":"RepositoryBranch", "documentation":"

The specific branch where the artifact resides.

" }, "ArtifactPath":{ "shape":"RepositoryArtifactPath", "documentation":"

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

" } }, "documentation":"

The subtype containing details about the Codestar connection `Type`.

" }, "ConstraintDescription":{ "type":"string", "max":2000 }, "ConstraintDetail":{ "type":"structure", "members":{ "ConstraintId":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" }, "Type":{ "shape":"ConstraintType", "documentation":"

The type of constraint.

- `LAUNCH`

- `NOTIFICATION`

- STACKSET

- `TEMPLATE`

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The description of the constraint.

" }, "Owner":{ "shape":"AccountId", "documentation":"

The owner of the constraint.

" }, "ProductId":{ "shape":"Id", "documentation":"

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

" }, "PortfolioId":{ "shape":"Id", "documentation":"

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

" } }, "documentation":"

Information about a constraint.

" }, "ConstraintDetails":{ "type":"list", "member":{"shape":"ConstraintDetail"} }, "ConstraintParameters":{"type":"string"}, "ConstraintSummaries":{ "type":"list", "member":{"shape":"ConstraintSummary"} }, "ConstraintSummary":{ "type":"structure", "members":{ "Type":{ "shape":"ConstraintType", "documentation":"

The type of constraint.

- `LAUNCH`

- `NOTIFICATION`

- STACKSET

- `TEMPLATE`

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The description of the constraint.

" } }, "documentation":"

Summary information about a constraint.

" }, "ConstraintType":{ "type":"string", "max":1024, "min":1 }, "CopyOption":{ "type":"string", "enum":["CopyTags"] }, "CopyOptions":{ "type":"list", "member":{"shape":"CopyOption"} }, "CopyProductInput":{ "type":"structure", "required":[ "SourceProductArn", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "SourceProductArn":{ "shape":"ProductArn", "documentation":"

The Amazon Resource Name (ARN) of the source product.

" }, "TargetProductId":{ "shape":"Id", "documentation":"

The identifier of the target product. By default, a new product is created.

" }, "TargetProductName":{ "shape":"ProductViewName", "documentation":"

A name for the target product. The default is the name of the source product.

" }, "SourceProvisioningArtifactIdentifiers":{ "shape":"SourceProvisioningArtifactProperties", "documentation":"

The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

" }, "CopyOptions":{ "shape":"CopyOptions", "documentation":"

The copy options. If the value is `CopyTags`, the tags from the source product are copied to the target product.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "CopyProductOutput":{ "type":"structure", "members":{ "CopyProductToken":{ "shape":"Id", "documentation":"

The token to use to track the progress of the operation.

" } } }, "CopyProductStatus":{ "type":"string", "enum":[ "SUCCEEDED", "IN_PROGRESS", "FAILED" ] }, "CreateConstraintInput":{ "type":"structure", "required":[ "PortfolioId", "ProductId", "Parameters", "Type", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Parameters":{ "shape":"ConstraintParameters", "documentation":"

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

LAUNCH

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

  Specify the `RoleArn` property as follows:

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

  Specify the `LocalRoleName` property as follows:

  `{\"LocalRoleName\": \"SCBasicLaunchRole\"}`

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

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

  You cannot have both a `LAUNCH` and a `STACKSET` constraint.

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

NOTIFICATION

  Specify the `NotificationArns` property as follows:

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

RESOURCE_UPDATE

  Specify the `TagUpdatesOnProvisionedProduct` property as follows:

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

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

STACKSET

  Specify the `Parameters` property as follows:

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

  You cannot have both a `LAUNCH` and a `STACKSET` constraint.

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

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

TEMPLATE

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

" }, "Type":{ "shape":"ConstraintType", "documentation":"

The type of constraint.

- `LAUNCH`

- `NOTIFICATION`

- `RESOURCE_UPDATE`

- `STACKSET`

- `TEMPLATE`

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The description of the constraint.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "CreateConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

Information about the constraint.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The constraint parameters.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "CreatePortfolioInput":{ "type":"structure", "required":[ "DisplayName", "ProviderName", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The description of the portfolio.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The name of the portfolio provider.

" }, "Tags":{ "shape":"AddTags", "documentation":"

One or more tags.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "CreatePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

Information about the portfolio.

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the portfolio.

" } } }, "CreatePortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "AccountId":{ "shape":"AccountId", "documentation":"

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

" }, "OrganizationNode":{ "shape":"OrganizationNode", "documentation":"

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

" }, "ShareTagOptions":{ "shape":"Boolean", "documentation":"

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

" }, "SharePrincipals":{ "shape":"Boolean", "documentation":"

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

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

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

" } } }, "CreatePortfolioShareOutput":{ "type":"structure", "members":{ "PortfolioShareToken":{ "shape":"Id", "documentation":"

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

" } } }, "CreateProductInput":{ "type":"structure", "required":[ "Name", "Owner", "ProductType", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The name of the product.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

The owner of the product.

" }, "Description":{ "shape":"ProductViewShortDescription", "documentation":"

The description of the product.

" }, "Distributor":{ "shape":"ProductViewOwner", "documentation":"

The distributor of the product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

The support information about the product.

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

The contact email for product support.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

The contact URL for product support.

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

" }, "ProductType":{ "shape":"ProductType", "documentation":"

The type of product.

" }, "Tags":{ "shape":"AddTags", "documentation":"

One or more tags.

" }, "ProvisioningArtifactParameters":{ "shape":"ProvisioningArtifactProperties", "documentation":"

The configuration of the provisioning artifact.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true }, "SourceConnection":{ "shape":"SourceConnection", "documentation":"

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

- `Type`

- `ConnectionParamters`

" } } }, "CreateProductOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

Information about the product view.

" }, "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

Information about the provisioning artifact.

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the product.

" } } }, "CreateProvisionedProductPlanInput":{ "type":"structure", "required":[ "PlanName", "PlanType", "ProductId", "ProvisionedProductName", "ProvisioningArtifactId", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PlanName":{ "shape":"ProvisionedProductPlanName", "documentation":"

The name of the plan.

" }, "PlanType":{ "shape":"ProvisionedProductPlanType", "documentation":"

The plan type.

" }, "NotificationArns":{ "shape":"NotificationArns", "documentation":"

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

" }, "PathId":{ "shape":"Id", "documentation":"

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

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

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":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProvisioningParameters":{ "shape":"UpdateProvisioningParameters", "documentation":"

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

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true }, "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

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

" } } }, "CreateProvisionedProductPlanOutput":{ "type":"structure", "members":{ "PlanName":{ "shape":"ProvisionedProductPlanName", "documentation":"

The name of the plan.

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "ProvisionProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

The user-friendly name of the provisioned product.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" } } }, "CreateProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "Parameters", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Parameters":{ "shape":"ProvisioningArtifactProperties", "documentation":"

The configuration for the provisioning artifact.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "CreateProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

Information about the provisioning artifact.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

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

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

`LoadTemplateFromURL`

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

`ImportFromPhysicalId`

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

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "CreateServiceActionInput":{ "type":"structure", "required":[ "Name", "DefinitionType", "Definition", "IdempotencyToken" ], "members":{ "Name":{ "shape":"ServiceActionName", "documentation":"

The self-service action name.

" }, "DefinitionType":{ "shape":"ServiceActionDefinitionType", "documentation":"

The service action definition type. For example, `SSM_AUTOMATION`.

" }, "Definition":{ "shape":"ServiceActionDefinitionMap", "documentation":"

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

Name

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

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

Version

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

AssumeRole

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

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

Parameters

  The list of parameters in JSON format.

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

" }, "Description":{ "shape":"ServiceActionDescription", "documentation":"

The self-service action description.

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "CreateServiceActionOutput":{ "type":"structure", "members":{ "ServiceActionDetail":{ "shape":"ServiceActionDetail", "documentation":"

An object containing information about the self-service action.

" } } }, "CreateTagOptionInput":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagOptionKey", "documentation":"

The TagOption key.

" }, "Value":{ "shape":"TagOptionValue", "documentation":"

The TagOption value.

" } } }, "CreateTagOptionOutput":{ "type":"structure", "members":{ "TagOptionDetail":{ "shape":"TagOptionDetail", "documentation":"

Information about the TagOption.

" } } }, "CreatedTime":{"type":"timestamp"}, "CreationTime":{"type":"timestamp"}, "DefaultValue":{"type":"string"}, "DeleteConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" } } }, "DeleteConstraintOutput":{ "type":"structure", "members":{ } }, "DeletePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "DeletePortfolioOutput":{ "type":"structure", "members":{ } }, "DeletePortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "AccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account ID.

" }, "OrganizationNode":{ "shape":"OrganizationNode", "documentation":"

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

" } } }, "DeletePortfolioShareOutput":{ "type":"structure", "members":{ "PortfolioShareToken":{ "shape":"Id", "documentation":"

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

" } } }, "DeleteProductInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The product identifier.

" } } }, "DeleteProductOutput":{ "type":"structure", "members":{ } }, "DeleteProvisionedProductPlanInput":{ "type":"structure", "required":["PlanId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "IgnoreErrors":{ "shape":"IgnoreErrors", "documentation":"

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

" } } }, "DeleteProvisionedProductPlanOutput":{ "type":"structure", "members":{ } }, "DeleteProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" } } }, "DeleteProvisioningArtifactOutput":{ "type":"structure", "members":{ } }, "DeleteServiceActionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", "idempotencyToken":true } } }, "DeleteServiceActionOutput":{ "type":"structure", "members":{ } }, "DeleteTagOptionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" } } }, "DeleteTagOptionOutput":{ "type":"structure", "members":{ } }, "DescribeConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" } } }, "DescribeConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

Information about the constraint.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The constraint parameters.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "DescribeCopyProductStatusInput":{ "type":"structure", "required":["CopyProductToken"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "CopyProductToken":{ "shape":"Id", "documentation":"

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

" } } }, "DescribeCopyProductStatusOutput":{ "type":"structure", "members":{ "CopyProductStatus":{ "shape":"CopyProductStatus", "documentation":"

The status of the copy product operation.

" }, "TargetProductId":{ "shape":"Id", "documentation":"

The identifier of the copied product.

" }, "StatusDetail":{ "shape":"StatusDetail", "documentation":"

The status message.

" } } }, "DescribePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "DescribePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

Information about the portfolio.

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the portfolio.

" }, "TagOptions":{ "shape":"TagOptionDetails", "documentation":"

Information about the TagOptions associated with the portfolio.

" }, "Budgets":{ "shape":"Budgets", "documentation":"

Information about the associated budgets.

" } } }, "DescribePortfolioShareStatusInput":{ "type":"structure", "required":["PortfolioShareToken"], "members":{ "PortfolioShareToken":{ "shape":"Id", "documentation":"

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

" } } }, "DescribePortfolioShareStatusOutput":{ "type":"structure", "members":{ "PortfolioShareToken":{ "shape":"Id", "documentation":"

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

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "OrganizationNodeValue":{ "shape":"OrganizationNodeValue", "documentation":"

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

" }, "Status":{ "shape":"ShareStatus", "documentation":"

Status of the portfolio share operation.

" }, "ShareDetails":{ "shape":"ShareDetails", "documentation":"

Information about the portfolio share operation.

" } } }, "DescribePortfolioShareType":{ "type":"string", "enum":[ "ACCOUNT", "ORGANIZATION", "ORGANIZATIONAL_UNIT", "ORGANIZATION_MEMBER_ACCOUNT" ] }, "DescribePortfolioSharesInput":{ "type":"structure", "required":[ "PortfolioId", "Type" ], "members":{ "PortfolioId":{ "shape":"Id", "documentation":"

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

" }, "Type":{ "shape":"DescribePortfolioShareType", "documentation":"

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.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" } } }, "DescribePortfolioSharesOutput":{ "type":"structure", "members":{ "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PortfolioShareDetails":{ "shape":"PortfolioShareDetails", "documentation":"

Summaries about each of the portfolio shares.

" } } }, "DescribeProductAsAdminInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The product name.

" }, "SourcePortfolioId":{ "shape":"Id", "documentation":"

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.

" } } }, "DescribeProductAsAdminOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

Information about the product view.

" }, "ProvisioningArtifactSummaries":{ "shape":"ProvisioningArtifactSummaries", "documentation":"

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

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the product.

" }, "TagOptions":{ "shape":"TagOptionDetails", "documentation":"

Information about the TagOptions associated with the product.

" }, "Budgets":{ "shape":"Budgets", "documentation":"

Information about the associated budgets.

" } } }, "DescribeProductInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The product name.

" } } }, "DescribeProductOutput":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

Summary information about the product view.

" }, "ProvisioningArtifacts":{ "shape":"ProvisioningArtifacts", "documentation":"

Information about the provisioning artifacts for the specified product.

" }, "Budgets":{ "shape":"Budgets", "documentation":"

Information about the associated budgets.

" }, "LaunchPaths":{ "shape":"LaunchPaths", "documentation":"

Information about the associated launch paths.

" } } }, "DescribeProductViewInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The product view identifier.

" } } }, "DescribeProductViewOutput":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

Summary information about the product.

" }, "ProvisioningArtifacts":{ "shape":"ProvisioningArtifacts", "documentation":"

Information about the provisioning artifacts for the product.

" } } }, "DescribeProvisionedProductInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

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

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

" }, "Name":{ "shape":"ProvisionedProductName", "documentation":"

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

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

" } }, "documentation":"DescribeProvisionedProductAPI input structure. AcceptLanguage - [Optional] The language code for localization. Id - [Optional] The provisioned product identifier. Name - [Optional] Another provisioned product identifier. Customers must provide either Id or Name." }, "DescribeProvisionedProductOutput":{ "type":"structure", "members":{ "ProvisionedProductDetail":{ "shape":"ProvisionedProductDetail", "documentation":"

Information about the provisioned product.

" }, "CloudWatchDashboards":{ "shape":"CloudWatchDashboards", "documentation":"

Any CloudWatch dashboards that were created when provisioning the product.

" } } }, "DescribeProvisionedProductPlanInput":{ "type":"structure", "required":["PlanId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "DescribeProvisionedProductPlanOutput":{ "type":"structure", "members":{ "ProvisionedProductPlanDetails":{ "shape":"ProvisionedProductPlanDetails", "documentation":"

Information about the plan.

" }, "ResourceChanges":{ "shape":"ResourceChanges", "documentation":"

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

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "DescribeProvisioningArtifactInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactName":{ "shape":"ProvisioningArtifactName", "documentation":"

The provisioning artifact name.

" }, "ProductName":{ "shape":"ProductViewName", "documentation":"

The product name.

" }, "Verbose":{ "shape":"Verbose", "documentation":"

Indicates whether a verbose level of detail is enabled.

" }, "IncludeProvisioningArtifactParameters":{ "shape":"Boolean", "documentation":"

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

" } } }, "DescribeProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

Information about the provisioning artifact.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

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

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" }, "ProvisioningArtifactParameters":{ "shape":"ProvisioningArtifactParameters", "documentation":"

Information about the parameters used to provision the product.

" } } }, "DescribeProvisioningParametersInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

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

" }, "ProductName":{ "shape":"ProductViewName", "documentation":"

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

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "ProvisioningArtifactName":{ "shape":"ProvisioningArtifactName", "documentation":"

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

" }, "PathId":{ "shape":"Id", "documentation":"

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":{ "shape":"PortfolioDisplayName", "documentation":"

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

" } } }, "DescribeProvisioningParametersOutput":{ "type":"structure", "members":{ "ProvisioningArtifactParameters":{ "shape":"ProvisioningArtifactParameters", "documentation":"

Information about the parameters used to provision the product.

" }, "ConstraintSummaries":{ "shape":"ConstraintSummaries", "documentation":"

Information about the constraints used to provision the product.

" }, "UsageInstructions":{ "shape":"UsageInstructions", "documentation":"

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

" }, "TagOptions":{ "shape":"TagOptionSummaries", "documentation":"

Information about the TagOptions associated with the resource.

" }, "ProvisioningArtifactPreferences":{ "shape":"ProvisioningArtifactPreferences", "documentation":"

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

" }, "ProvisioningArtifactOutputs":{ "shape":"ProvisioningArtifactOutputs", "documentation":"

The output of the provisioning artifact.

", "deprecated":true, "deprecatedMessage":"This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs." }, "ProvisioningArtifactOutputKeys":{ "shape":"ProvisioningArtifactOutputs", "documentation":"

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

" } } }, "DescribeRecordInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

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

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" } } }, "DescribeRecordOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Information about the product.

" }, "RecordOutputs":{ "shape":"RecordOutputs", "documentation":"

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.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "DescribeServiceActionExecutionParametersInput":{ "type":"structure", "required":[ "ProvisionedProductId", "ServiceActionId" ], "members":{ "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "ServiceActionId":{ "shape":"Id", "documentation":"

The self-service action identifier.

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "DescribeServiceActionExecutionParametersOutput":{ "type":"structure", "members":{ "ServiceActionParameters":{ "shape":"ExecutionParameters", "documentation":"

The parameters of the self-service action.

" } } }, "DescribeServiceActionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The self-service action identifier.

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "DescribeServiceActionOutput":{ "type":"structure", "members":{ "ServiceActionDetail":{ "shape":"ServiceActionDetail", "documentation":"

Detailed information about the self-service action.

" } } }, "DescribeTagOptionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" } } }, "DescribeTagOptionOutput":{ "type":"structure", "members":{ "TagOptionDetail":{ "shape":"TagOptionDetail", "documentation":"

Information about the TagOption.

" } } }, "Description":{"type":"string"}, "DisableAWSOrganizationsAccessInput":{ "type":"structure", "members":{ } }, "DisableAWSOrganizationsAccessOutput":{ "type":"structure", "members":{ } }, "DisableTemplateValidation":{"type":"boolean"}, "DisassociateBudgetFromResourceInput":{ "type":"structure", "required":[ "BudgetName", "ResourceId" ], "members":{ "BudgetName":{ "shape":"BudgetName", "documentation":"

The name of the budget you want to disassociate.

" }, "ResourceId":{ "shape":"Id", "documentation":"

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

" } } }, "DisassociateBudgetFromResourceOutput":{ "type":"structure", "members":{ } }, "DisassociatePrincipalFromPortfolioInput":{ "type":"structure", "required":[ "PortfolioId", "PrincipalARN" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

The ARN of the principal (user, role, or group). This field allows an ARN with no `accountID` with or without wildcard characters if `PrincipalType` is `IAM_PATTERN`.

" }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"

The supported value is `IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you specify an `IAM` ARN with no AccountId, with or without wildcard characters.

" } } }, "DisassociatePrincipalFromPortfolioOutput":{ "type":"structure", "members":{ } }, "DisassociateProductFromPortfolioInput":{ "type":"structure", "required":[ "ProductId", "PortfolioId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "DisassociateProductFromPortfolioOutput":{ "type":"structure", "members":{ } }, "DisassociateServiceActionFromProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId", "ServiceActionId" ], "members":{ "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A unique identifier that you provide to ensure idempotency. If multiple requests from the same Amazon Web Services account use the same idempotency token, the same response is returned for each repeated request.

", "idempotencyToken":true } } }, "DisassociateServiceActionFromProvisioningArtifactOutput":{ "type":"structure", "members":{ } }, "DisassociateTagOptionFromResourceInput":{ "type":"structure", "required":[ "ResourceId", "TagOptionId" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource identifier.

" }, "TagOptionId":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" } } }, "DisassociateTagOptionFromResourceOutput":{ "type":"structure", "members":{ } }, "DuplicateResourceException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource is a duplicate.

", "exception":true }, "EnableAWSOrganizationsAccessInput":{ "type":"structure", "members":{ } }, "EnableAWSOrganizationsAccessOutput":{ "type":"structure", "members":{ } }, "EngineWorkflowFailureReason":{ "type":"string", "max":2048, "min":1, "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" }, "EngineWorkflowResourceIdentifier":{ "type":"structure", "members":{ "UniqueTag":{ "shape":"UniqueTagResourceIdentifier", "documentation":"

The unique key-value pair for a tag that identifies provisioned product resources.

" } }, "documentation":"

The ID for the provisioned product resources that are part of a resource group.

" }, "EngineWorkflowStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED" ] }, "EngineWorkflowToken":{ "type":"string", "max":20000, "min":1, "pattern":"[0-9A-Za-z+\\/=]+" }, "Error":{"type":"string"}, "ErrorCode":{"type":"string"}, "ErrorDescription":{"type":"string"}, "EvaluationType":{ "type":"string", "enum":[ "STATIC", "DYNAMIC" ] }, "ExecuteProvisionedProductPlanInput":{ "type":"structure", "required":[ "PlanId", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "ExecuteProvisionedProductPlanOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Information about the result of provisioning the product.

" } } }, "ExecuteProvisionedProductServiceActionInput":{ "type":"structure", "required":[ "ProvisionedProductId", "ServiceActionId", "ExecuteToken" ], "members":{ "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "ExecuteToken":{ "shape":"IdempotencyToken", "documentation":"

An idempotency token that uniquely identifies the execute request.

", "idempotencyToken":true }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Parameters":{ "shape":"ExecutionParameterMap", "documentation":"

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 as `TARGET`.

" } } }, "ExecuteProvisionedProductServiceActionOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

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

" } } }, "ExecutionParameter":{ "type":"structure", "members":{ "Name":{ "shape":"ExecutionParameterKey", "documentation":"

The name of the execution parameter.

" }, "Type":{ "shape":"ExecutionParameterType", "documentation":"

The execution parameter type.

" }, "DefaultValues":{ "shape":"ExecutionParameterValueList", "documentation":"

The default values for the execution parameter.

" } }, "documentation":"

Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.

" }, "ExecutionParameterKey":{ "type":"string", "max":50, "min":1 }, "ExecutionParameterMap":{ "type":"map", "key":{"shape":"ExecutionParameterKey"}, "value":{"shape":"ExecutionParameterValueList"}, "max":200, "min":1 }, "ExecutionParameterType":{ "type":"string", "max":1024, "min":1 }, "ExecutionParameterValue":{ "type":"string", "max":512, "min":0 }, "ExecutionParameterValueList":{ "type":"list", "member":{"shape":"ExecutionParameterValue"}, "max":25, "min":0 }, "ExecutionParameters":{ "type":"list", "member":{"shape":"ExecutionParameter"} }, "FailedServiceActionAssociation":{ "type":"structure", "members":{ "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "ErrorCode":{ "shape":"ServiceActionAssociationErrorCode", "documentation":"

The error code. Valid values are listed below.

" }, "ErrorMessage":{ "shape":"ServiceActionAssociationErrorMessage", "documentation":"

A text description of the error.

" } }, "documentation":"

An object containing information about the error, along with identifying information about the self-service action and its associations.

" }, "FailedServiceActionAssociations":{ "type":"list", "member":{"shape":"FailedServiceActionAssociation"}, "max":50 }, "GetAWSOrganizationsAccessStatusInput":{ "type":"structure", "members":{ } }, "GetAWSOrganizationsAccessStatusOutput":{ "type":"structure", "members":{ "AccessStatus":{ "shape":"AccessStatus", "documentation":"

The status of the portfolio share feature.

" } } }, "GetProvisionedProductOutputsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product that you want the outputs from.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

The name of the provisioned product that you want the outputs from.

" }, "OutputKeys":{ "shape":"OutputKeys", "documentation":"

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":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "GetProvisionedProductOutputsOutput":{ "type":"structure", "members":{ "Outputs":{ "shape":"RecordOutputs", "documentation":"

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.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "HasDefaultPath":{"type":"boolean"}, "Id":{ "type":"string", "max":100, "min":1, "pattern":"^[a-zA-Z0-9_\\-]*" }, "IdempotencyToken":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" }, "IgnoreErrors":{"type":"boolean"}, "ImportAsProvisionedProductInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId", "ProvisionedProductName", "PhysicalId", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

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.

" }, "PhysicalId":{ "shape":"PhysicalId", "documentation":"

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

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true } } }, "ImportAsProvisionedProductOutput":{ "type":"structure", "members":{ "RecordDetail":{"shape":"RecordDetail"} } }, "InstructionType":{"type":"string"}, "InstructionValue":{"type":"string"}, "InvalidParametersException":{ "type":"structure", "members":{ }, "documentation":"

One or more parameters provided to the operation are not valid.

", "exception":true }, "InvalidStateException":{ "type":"structure", "members":{ }, "documentation":"

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.

", "exception":true }, "LastRequestId":{"type":"string"}, "LastSuccessfulSyncTime":{"type":"timestamp"}, "LastSync":{ "type":"structure", "members":{ "LastSyncTime":{ "shape":"LastSyncTime", "documentation":"

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

" }, "LastSyncStatus":{ "shape":"LastSyncStatus", "documentation":"

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

" }, "LastSyncStatusMessage":{ "shape":"LastSyncStatusMessage", "documentation":"

The sync's status message.

" }, "LastSuccessfulSyncTime":{ "shape":"LastSuccessfulSyncTime", "documentation":"

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

" }, "LastSuccessfulSyncProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" } }, "documentation":"

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

- `LastSyncTime`

- `LastSyncStatus`

- `LastSyncStatusMessage`

- `LastSuccessfulSyncTime`

- `LastSuccessfulSyncProvisioningArtifactID`

" }, "LastSyncStatus":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED" ] }, "LastSyncStatusMessage":{"type":"string"}, "LastSyncTime":{"type":"timestamp"}, "LaunchPath":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the launch path.

" }, "Name":{ "shape":"PortfolioName", "documentation":"

The name of the launch path.

" } }, "documentation":"

A launch path object.

" }, "LaunchPathSummaries":{ "type":"list", "member":{"shape":"LaunchPathSummary"} }, "LaunchPathSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the product path.

" }, "ConstraintSummaries":{ "shape":"ConstraintSummaries", "documentation":"

The constraints on the portfolio-product relationship.

" }, "Tags":{ "shape":"Tags", "documentation":"

The tags associated with this product path.

" }, "Name":{ "shape":"PortfolioName", "documentation":"

The name of the portfolio that contains the product.

" } }, "documentation":"

Summary information about a product path for a user.

" }, "LaunchPaths":{ "type":"list", "member":{"shape":"LaunchPath"} }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

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.

", "exception":true }, "ListAcceptedPortfolioSharesInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" }, "PortfolioShareType":{ "shape":"PortfolioShareType", "documentation":"

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.

" } } }, "ListAcceptedPortfolioSharesOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

Information about the portfolios.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListBudgetsForResourceInput":{ "type":"structure", "required":["ResourceId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ResourceId":{ "shape":"Id", "documentation":"

The resource identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListBudgetsForResourceOutput":{ "type":"structure", "members":{ "Budgets":{ "shape":"Budgets", "documentation":"

Information about the associated budgets.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListConstraintsForPortfolioInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListConstraintsForPortfolioOutput":{ "type":"structure", "members":{ "ConstraintDetails":{ "shape":"ConstraintDetails", "documentation":"

Information about the constraints.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListLaunchPathsInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListLaunchPathsOutput":{ "type":"structure", "members":{ "LaunchPathSummaries":{ "shape":"LaunchPathSummaries", "documentation":"

Information about the launch path.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListOrganizationPortfolioAccessInput":{ "type":"structure", "required":[ "PortfolioId", "OrganizationNodeType" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier. For example, `port-2abcdext3y5fk`.

" }, "OrganizationNodeType":{ "shape":"OrganizationNodeType", "documentation":"

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.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" } } }, "ListOrganizationPortfolioAccessOutput":{ "type":"structure", "members":{ "OrganizationNodes":{ "shape":"OrganizationNodes", "documentation":"

Displays information about the organization nodes.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListPortfolioAccessInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "OrganizationParentId":{ "shape":"Id", "documentation":"

The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" } } }, "ListPortfolioAccessOutput":{ "type":"structure", "members":{ "AccountIds":{ "shape":"AccountIds", "documentation":"

Information about the Amazon Web Services accounts with access to the portfolio.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListPortfoliosForProductInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" } } }, "ListPortfoliosForProductOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

Information about the portfolios.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListPortfoliosInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" } } }, "ListPortfoliosOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

Information about the portfolios.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListPrincipalsForPortfolioInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListPrincipalsForPortfolioOutput":{ "type":"structure", "members":{ "Principals":{ "shape":"Principals", "documentation":"

The `PrincipalARN`s and corresponding `PrincipalType`s associated with the portfolio.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListProvisionedProductPlansInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisionProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

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

" } } }, "ListProvisionedProductPlansOutput":{ "type":"structure", "members":{ "ProvisionedProductPlans":{ "shape":"ProvisionedProductPlans", "documentation":"

Information about the plans.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListProvisioningArtifactsForServiceActionInput":{ "type":"structure", "required":["ServiceActionId"], "members":{ "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "ListProvisioningArtifactsForServiceActionOutput":{ "type":"structure", "members":{ "ProvisioningArtifactViews":{ "shape":"ProvisioningArtifactViews", "documentation":"

An array of objects with information about product views and provisioning artifacts.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListProvisioningArtifactsInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" } } }, "ListProvisioningArtifactsOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetails":{ "shape":"ProvisioningArtifactDetails", "documentation":"

Information about the provisioning artifacts.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListRecordHistoryInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

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

" }, "SearchFilter":{ "shape":"ListRecordHistorySearchFilter", "documentation":"

The search filter to scope the results.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListRecordHistoryOutput":{ "type":"structure", "members":{ "RecordDetails":{ "shape":"RecordDetails", "documentation":"

The records, in reverse chronological order.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListRecordHistorySearchFilter":{ "type":"structure", "members":{ "Key":{ "shape":"SearchFilterKey", "documentation":"

The filter key.

- `product` - Filter results based on the specified product identifier.

- `provisionedproduct` - Filter results based on the provisioned product identifier.

" }, "Value":{ "shape":"SearchFilterValue", "documentation":"

The filter value.

" } }, "documentation":"

The search filter to use when listing history records.

" }, "ListResourcesForTagOptionInput":{ "type":"structure", "required":["TagOptionId"], "members":{ "TagOptionId":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

- `Portfolio`

- `Product`

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListResourcesForTagOptionOutput":{ "type":"structure", "members":{ "ResourceDetails":{ "shape":"ResourceDetails", "documentation":"

Information about the resources.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListServiceActionsForProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "ListServiceActionsForProvisioningArtifactOutput":{ "type":"structure", "members":{ "ServiceActionSummaries":{ "shape":"ServiceActionSummaries", "documentation":"

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

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListServiceActionsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListServiceActionsOutput":{ "type":"structure", "members":{ "ServiceActionSummaries":{ "shape":"ServiceActionSummaries", "documentation":"

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

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListStackInstancesForProvisionedProductInput":{ "type":"structure", "required":["ProvisionedProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" } } }, "ListStackInstancesForProvisionedProductOutput":{ "type":"structure", "members":{ "StackInstances":{ "shape":"StackInstances", "documentation":"

List of stack instances.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListTagOptionsFilters":{ "type":"structure", "members":{ "Key":{ "shape":"TagOptionKey", "documentation":"

The TagOption key.

" }, "Value":{ "shape":"TagOptionValue", "documentation":"

The TagOption value.

" }, "Active":{ "shape":"TagOptionActive", "documentation":"

The active state.

" } }, "documentation":"

Filters to use when listing TagOptions.

" }, "ListTagOptionsInput":{ "type":"structure", "members":{ "Filters":{ "shape":"ListTagOptionsFilters", "documentation":"

The search filters. If no search filters are specified, the output includes all TagOptions.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ListTagOptionsOutput":{ "type":"structure", "members":{ "TagOptionDetails":{ "shape":"TagOptionDetails", "documentation":"

Information about the TagOptions.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "LogicalResourceId":{"type":"string"}, "Message":{"type":"string"}, "Namespaces":{ "type":"list", "member":{"shape":"AccountId"} }, "NoEcho":{"type":"boolean"}, "NotificationArn":{ "type":"string", "max":1224, "min":1, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "NotificationArns":{ "type":"list", "member":{"shape":"NotificationArn"}, "max":5 }, "NotifyProvisionProductEngineWorkflowResultInput":{ "type":"structure", "required":[ "WorkflowToken", "RecordId", "Status", "IdempotencyToken" ], "members":{ "WorkflowToken":{ "shape":"EngineWorkflowToken", "documentation":"

The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

" }, "RecordId":{ "shape":"Id", "documentation":"

The identifier of the record.

" }, "Status":{ "shape":"EngineWorkflowStatus", "documentation":"

The status of the provisioning engine execution.

" }, "FailureReason":{ "shape":"EngineWorkflowFailureReason", "documentation":"

The reason why the provisioning engine execution failed.

" }, "ResourceIdentifier":{ "shape":"EngineWorkflowResourceIdentifier", "documentation":"

The ID for the provisioned product resources that are part of a resource group.

" }, "Outputs":{ "shape":"RecordOutputs", "documentation":"

The output of the provisioning engine execution.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that identifies the provisioning engine execution.

", "idempotencyToken":true } } }, "NotifyProvisionProductEngineWorkflowResultOutput":{ "type":"structure", "members":{ } }, "NotifyTerminateProvisionedProductEngineWorkflowResultInput":{ "type":"structure", "required":[ "WorkflowToken", "RecordId", "Status", "IdempotencyToken" ], "members":{ "WorkflowToken":{ "shape":"EngineWorkflowToken", "documentation":"

The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

" }, "RecordId":{ "shape":"Id", "documentation":"

The identifier of the record.

" }, "Status":{ "shape":"EngineWorkflowStatus", "documentation":"

The status of the terminate engine execution.

" }, "FailureReason":{ "shape":"EngineWorkflowFailureReason", "documentation":"

The reason why the terminate engine execution failed.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that identifies the terminate engine execution.

", "idempotencyToken":true } } }, "NotifyTerminateProvisionedProductEngineWorkflowResultOutput":{ "type":"structure", "members":{ } }, "NotifyUpdateProvisionedProductEngineWorkflowResultInput":{ "type":"structure", "required":[ "WorkflowToken", "RecordId", "Status", "IdempotencyToken" ], "members":{ "WorkflowToken":{ "shape":"EngineWorkflowToken", "documentation":"

The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

" }, "RecordId":{ "shape":"Id", "documentation":"

The identifier of the record.

" }, "Status":{ "shape":"EngineWorkflowStatus", "documentation":"

The status of the update engine execution.

" }, "FailureReason":{ "shape":"EngineWorkflowFailureReason", "documentation":"

The reason why the update engine execution failed.

" }, "Outputs":{ "shape":"RecordOutputs", "documentation":"

The output of the update engine execution.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that identifies the update engine execution.

", "idempotencyToken":true } } }, "NotifyUpdateProvisionedProductEngineWorkflowResultOutput":{ "type":"structure", "members":{ } }, "NullableBoolean":{ "type":"boolean", "box":true }, "OperationNotSupportedException":{ "type":"structure", "members":{ }, "documentation":"

The operation is not supported.

", "exception":true }, "OrganizationNode":{ "type":"structure", "members":{ "Type":{ "shape":"OrganizationNodeType", "documentation":"

The organization node type.

" }, "Value":{ "shape":"OrganizationNodeValue", "documentation":"

The identifier of the organization node.

" } }, "documentation":"

Information about the organization node.

" }, "OrganizationNodeType":{ "type":"string", "enum":[ "ORGANIZATION", "ORGANIZATIONAL_UNIT", "ACCOUNT" ] }, "OrganizationNodeValue":{ "type":"string", "pattern":"(^[0-9]{12}$)|(^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)" }, "OrganizationNodes":{ "type":"list", "member":{"shape":"OrganizationNode"} }, "OutputDescription":{ "type":"string", "max":1024 }, "OutputKey":{"type":"string"}, "OutputKeys":{ "type":"list", "member":{"shape":"OutputKey"}, "max":60 }, "OutputValue":{"type":"string"}, "Owner":{"type":"string"}, "PageSize":{ "type":"integer", "max":20, "min":0 }, "PageSizeMax100":{ "type":"integer", "max":100, "min":0 }, "PageToken":{ "type":"string", "max":2024, "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" }, "ParameterConstraints":{ "type":"structure", "members":{ "AllowedValues":{ "shape":"AllowedValues", "documentation":"

The values that the administrator has allowed for the parameter.

" }, "AllowedPattern":{ "shape":"String", "documentation":"

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

" }, "ConstraintDescription":{ "shape":"String", "documentation":"

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":{ "shape":"String", "documentation":"

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

" }, "MinLength":{ "shape":"String", "documentation":"

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

" }, "MaxValue":{ "shape":"String", "documentation":"

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

" }, "MinValue":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

The constraints that the administrator has put on the parameter.

" }, "ParameterKey":{ "type":"string", "max":1000, "min":1 }, "ParameterType":{"type":"string"}, "ParameterValue":{ "type":"string", "max":4096 }, "PhysicalId":{"type":"string"}, "PhysicalResourceId":{"type":"string"}, "PlanResourceType":{ "type":"string", "max":256, "min":1 }, "PortfolioDescription":{ "type":"string", "max":2000 }, "PortfolioDetail":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "ARN":{ "shape":"ResourceARN", "documentation":"

The ARN assigned to the portfolio.

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The description of the portfolio.

" }, "CreatedTime":{ "shape":"CreationTime", "documentation":"

The UTC time stamp of the creation time.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The name of the portfolio provider.

" } }, "documentation":"

Information about a portfolio.

" }, "PortfolioDetails":{ "type":"list", "member":{"shape":"PortfolioDetail"} }, "PortfolioDisplayName":{ "type":"string", "max":100, "min":1 }, "PortfolioName":{"type":"string"}, "PortfolioShareDetail":{ "type":"structure", "members":{ "PrincipalId":{ "shape":"Id", "documentation":"

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

1. An external account.

2. An organziation member account.

3. An organzational unit (OU).

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

" }, "Type":{ "shape":"DescribePortfolioShareType", "documentation":"

The type of the portfolio share.

" }, "Accepted":{ "shape":"Boolean", "documentation":"

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

" }, "ShareTagOptions":{ "shape":"Boolean", "documentation":"

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

" }, "SharePrincipals":{ "shape":"Boolean", "documentation":"

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

" } }, "documentation":"

Information about the portfolio share.

" }, "PortfolioShareDetails":{ "type":"list", "member":{"shape":"PortfolioShareDetail"} }, "PortfolioShareType":{ "type":"string", "enum":[ "IMPORTED", "AWS_SERVICECATALOG", "AWS_ORGANIZATIONS" ] }, "Principal":{ "type":"structure", "members":{ "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

The ARN of the principal (user, role, or group). This field allows for an ARN with no `accountID`, with or without wildcard characters if the `PrincipalType` is an `IAM_PATTERN`.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

" }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"

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

" } }, "documentation":"

Information about a principal.

" }, "PrincipalARN":{ "type":"string", "max":1000, "min":1 }, "PrincipalType":{ "type":"string", "enum":[ "IAM", "IAM_PATTERN" ] }, "Principals":{ "type":"list", "member":{"shape":"Principal"} }, "ProductArn":{ "type":"string", "max":1224, "min":1, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "ProductSource":{ "type":"string", "enum":["ACCOUNT"] }, "ProductType":{ "type":"string", "enum":[ "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL" ], "max":8191 }, "ProductViewAggregationType":{"type":"string"}, "ProductViewAggregationValue":{ "type":"structure", "members":{ "Value":{ "shape":"AttributeValue", "documentation":"

The value of the product view aggregation.

" }, "ApproximateCount":{ "shape":"ApproximateCount", "documentation":"

An approximate count of the products that match the value.

" } }, "documentation":"

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

" }, "ProductViewAggregationValues":{ "type":"list", "member":{"shape":"ProductViewAggregationValue"} }, "ProductViewAggregations":{ "type":"map", "key":{"shape":"ProductViewAggregationType"}, "value":{"shape":"ProductViewAggregationValues"} }, "ProductViewDetail":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

Summary information about the product view.

" }, "Status":{ "shape":"Status", "documentation":"

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.

" }, "ProductARN":{ "shape":"ResourceARN", "documentation":"

The ARN of the product.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "SourceConnection":{ "shape":"SourceConnectionDetail", "documentation":"

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.

" } }, "documentation":"

Information about a product view.

" }, "ProductViewDetails":{ "type":"list", "member":{"shape":"ProductViewDetail"} }, "ProductViewDistributor":{"type":"string"}, "ProductViewFilterBy":{ "type":"string", "enum":[ "FullTextSearch", "Owner", "ProductType", "SourceProductId" ] }, "ProductViewFilterValue":{"type":"string"}, "ProductViewFilterValues":{ "type":"list", "member":{"shape":"ProductViewFilterValue"} }, "ProductViewFilters":{ "type":"map", "key":{"shape":"ProductViewFilterBy"}, "value":{"shape":"ProductViewFilterValues"} }, "ProductViewName":{ "type":"string", "max":8191 }, "ProductViewOwner":{ "type":"string", "max":8191 }, "ProductViewShortDescription":{ "type":"string", "max":8191 }, "ProductViewSortBy":{ "type":"string", "enum":[ "Title", "VersionCount", "CreationDate" ] }, "ProductViewSummaries":{ "type":"list", "member":{"shape":"ProductViewSummary"} }, "ProductViewSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The product view identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The name of the product.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

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

" }, "ShortDescription":{ "shape":"ProductViewShortDescription", "documentation":"

Short description of the product.

" }, "Type":{ "shape":"ProductType", "documentation":"

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.

" }, "Distributor":{ "shape":"ProductViewDistributor", "documentation":"

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

" }, "HasDefaultPath":{ "shape":"HasDefaultPath", "documentation":"

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

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

The email contact information to obtain support for this Product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

The description of the support for this Product.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

The URL information to obtain support for this Product.

" } }, "documentation":"

Summary information about a product view.

" }, "PropertyKey":{ "type":"string", "enum":[ "OWNER", "LAUNCH_ROLE" ], "max":128, "min":1 }, "PropertyName":{"type":"string"}, "PropertyValue":{ "type":"string", "max":1024, "min":0 }, "ProviderName":{ "type":"string", "max":50, "min":1 }, "ProvisionProductInput":{ "type":"structure", "required":[ "ProvisionedProductName", "ProvisionToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

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

" }, "ProductName":{ "shape":"ProductViewName", "documentation":"

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

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "ProvisioningArtifactName":{ "shape":"ProvisioningArtifactName", "documentation":"

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

" }, "PathId":{ "shape":"Id", "documentation":"

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":{ "shape":"PortfolioDisplayName", "documentation":"

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

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

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.

" }, "ProvisioningParameters":{ "shape":"ProvisioningParameters", "documentation":"

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

" }, "ProvisioningPreferences":{ "shape":"ProvisioningPreferences", "documentation":"

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

" }, "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

" }, "NotificationArns":{ "shape":"NotificationArns", "documentation":"

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

" }, "ProvisionToken":{ "shape":"IdempotencyToken", "documentation":"

An idempotency token that uniquely identifies the provisioning request.

", "idempotencyToken":true } } }, "ProvisionProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Information about the result of provisioning the product.

" } } }, "ProvisionedProductAttribute":{ "type":"structure", "members":{ "Name":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The user-friendly name of the provisioned product.

" }, "Arn":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The ARN of the provisioned product.

" }, "Type":{ "shape":"ProvisionedProductType", "documentation":"

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

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "Status":{ "shape":"ProvisionedProductStatus", "documentation":"

The current status of the provisioned product.

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

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

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

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

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

" }, "StatusMessage":{ "shape":"ProvisionedProductStatusMessage", "documentation":"

The current status message of the provisioned product.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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

" }, "LastRecordId":{ "shape":"Id", "documentation":"

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

" }, "LastProvisioningRecordId":{ "shape":"Id", "documentation":"

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

- ProvisionProduct

- UpdateProvisionedProduct

- ExecuteProvisionedProductPlan

- TerminateProvisionedProduct

" }, "LastSuccessfulProvisioningRecordId":{ "shape":"Id", "documentation":"

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

- ProvisionProduct

- UpdateProvisionedProduct

- ExecuteProvisionedProductPlan

- TerminateProvisionedProduct

" }, "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

" }, "PhysicalId":{ "shape":"PhysicalId", "documentation":"

The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProductName":{ "shape":"ProductViewName", "documentation":"

The name of the product.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProvisioningArtifactName":{ "shape":"ProvisioningArtifactName", "documentation":"

The name of the provisioning artifact.

" }, "UserArn":{ "shape":"UserArn", "documentation":"

The Amazon Resource Name (ARN) of the user.

" }, "UserArnSession":{ "shape":"UserArnSession", "documentation":"

The ARN of the user in the session. This ARN might contain a session ID.

" } }, "documentation":"

Information about a provisioned product.

" }, "ProvisionedProductAttributes":{ "type":"list", "member":{"shape":"ProvisionedProductAttribute"} }, "ProvisionedProductDetail":{ "type":"structure", "members":{ "Name":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The user-friendly name of the provisioned product.

" }, "Arn":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The ARN of the provisioned product.

" }, "Type":{ "shape":"ProvisionedProductType", "documentation":"

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

" }, "Id":{ "shape":"ProvisionedProductId", "documentation":"

The identifier of the provisioned product.

" }, "Status":{ "shape":"ProvisionedProductStatus", "documentation":"

The current status of the provisioned product.

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

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

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

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

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

" }, "StatusMessage":{ "shape":"ProvisionedProductStatusMessage", "documentation":"

The current status message of the provisioned product.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

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

" }, "LastRecordId":{ "shape":"LastRequestId", "documentation":"

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

" }, "LastProvisioningRecordId":{ "shape":"Id", "documentation":"

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

- ProvisionProduct

- UpdateProvisionedProduct

- ExecuteProvisionedProductPlan

- TerminateProvisionedProduct

" }, "LastSuccessfulProvisioningRecordId":{ "shape":"Id", "documentation":"

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

- ProvisionProduct

- UpdateProvisionedProduct

- ExecuteProvisionedProductPlan

- TerminateProvisionedProduct

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" }, "LaunchRoleArn":{ "shape":"RoleArn", "documentation":"

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

" } }, "documentation":"

Information about a provisioned product.

" }, "ProvisionedProductDetails":{ "type":"list", "member":{"shape":"ProvisionedProductDetail"} }, "ProvisionedProductFilters":{ "type":"map", "key":{"shape":"ProvisionedProductViewFilterBy"}, "value":{"shape":"ProvisionedProductViewFilterValues"} }, "ProvisionedProductId":{"type":"string"}, "ProvisionedProductName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9._-]*" }, "ProvisionedProductNameOrArn":{ "type":"string", "max":1224, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "ProvisionedProductPlanDetails":{ "type":"structure", "members":{ "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "PathId":{ "shape":"Id", "documentation":"

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

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PlanName":{ "shape":"ProvisionedProductPlanName", "documentation":"

The name of the plan.

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "ProvisionProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisionProductName":{ "shape":"ProvisionedProductName", "documentation":"

The user-friendly name of the provisioned product.

" }, "PlanType":{ "shape":"ProvisionedProductPlanType", "documentation":"

The plan type.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Status":{ "shape":"ProvisionedProductPlanStatus", "documentation":"

The status.

" }, "UpdatedTime":{ "shape":"UpdatedTime", "documentation":"

The UTC time stamp when the plan was last updated.

" }, "NotificationArns":{ "shape":"NotificationArns", "documentation":"

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

" }, "ProvisioningParameters":{ "shape":"UpdateProvisioningParameters", "documentation":"

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

" }, "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

" }, "StatusMessage":{ "shape":"StatusMessage", "documentation":"

The status message.

" } }, "documentation":"

Information about a plan.

" }, "ProvisionedProductPlanName":{"type":"string"}, "ProvisionedProductPlanStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_SUCCESS", "CREATE_FAILED", "EXECUTE_IN_PROGRESS", "EXECUTE_SUCCESS", "EXECUTE_FAILED" ] }, "ProvisionedProductPlanSummary":{ "type":"structure", "members":{ "PlanName":{ "shape":"ProvisionedProductPlanName", "documentation":"

The name of the plan.

" }, "PlanId":{ "shape":"Id", "documentation":"

The plan identifier.

" }, "ProvisionProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisionProductName":{ "shape":"ProvisionedProductName", "documentation":"

The user-friendly name of the provisioned product.

" }, "PlanType":{ "shape":"ProvisionedProductPlanType", "documentation":"

The plan type.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" } }, "documentation":"

Summary information about a plan.

" }, "ProvisionedProductPlanType":{ "type":"string", "enum":["CLOUDFORMATION"] }, "ProvisionedProductPlans":{ "type":"list", "member":{"shape":"ProvisionedProductPlanSummary"} }, "ProvisionedProductProperties":{ "type":"map", "key":{"shape":"PropertyKey"}, "value":{"shape":"PropertyValue"}, "max":100, "min":1 }, "ProvisionedProductStatus":{ "type":"string", "enum":[ "AVAILABLE", "UNDER_CHANGE", "TAINTED", "ERROR", "PLAN_IN_PROGRESS" ] }, "ProvisionedProductStatusMessage":{"type":"string"}, "ProvisionedProductType":{"type":"string"}, "ProvisionedProductViewFilterBy":{ "type":"string", "enum":["SearchQuery"] }, "ProvisionedProductViewFilterValue":{"type":"string"}, "ProvisionedProductViewFilterValues":{ "type":"list", "member":{"shape":"ProvisionedProductViewFilterValue"} }, "ProvisioningArtifact":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name of the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The description of the provisioning artifact.

" }, "CreatedTime":{ "shape":"ProvisioningArtifactCreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "Guidance":{ "shape":"ProvisioningArtifactGuidance", "documentation":"

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

" } }, "documentation":"

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

" }, "ProvisioningArtifactActive":{"type":"boolean"}, "ProvisioningArtifactCreatedTime":{"type":"timestamp"}, "ProvisioningArtifactDescription":{ "type":"string", "max":8192 }, "ProvisioningArtifactDetail":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name of the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactName", "documentation":"

The description of the provisioning artifact.

" }, "Type":{ "shape":"ProvisioningArtifactType", "documentation":"

The type of provisioning artifact.

- `CLOUD_FORMATION_TEMPLATE` - CloudFormation template

- `TERRAFORM_OPEN_SOURCE` - Terraform Open Source configuration file

- `TERRAFORM_CLOUD` - Terraform Cloud configuration file

- `EXTERNAL` - External configuration file

" }, "CreatedTime":{ "shape":"CreationTime", "documentation":"

The UTC time stamp of the creation time.

" }, "Active":{ "shape":"ProvisioningArtifactActive", "documentation":"

Indicates whether the product version is active.

" }, "Guidance":{ "shape":"ProvisioningArtifactGuidance", "documentation":"

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

" }, "SourceRevision":{ "shape":"SourceRevision", "documentation":"

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

This field only exists for Repo-Synced products.

" } }, "documentation":"

Information about a provisioning artifact (also known as a version) for a product.

" }, "ProvisioningArtifactDetails":{ "type":"list", "member":{"shape":"ProvisioningArtifactDetail"} }, "ProvisioningArtifactGuidance":{ "type":"string", "enum":[ "DEFAULT", "DEPRECATED" ] }, "ProvisioningArtifactInfo":{ "type":"map", "key":{"shape":"ProvisioningArtifactInfoKey"}, "value":{"shape":"ProvisioningArtifactInfoValue"}, "max":100, "min":1 }, "ProvisioningArtifactInfoKey":{"type":"string"}, "ProvisioningArtifactInfoValue":{"type":"string"}, "ProvisioningArtifactName":{ "type":"string", "max":8192 }, "ProvisioningArtifactOutput":{ "type":"structure", "members":{ "Key":{ "shape":"ProvisioningArtifactOutputKey", "documentation":"

The provisioning artifact output key.

" }, "Description":{ "shape":"OutputDescription", "documentation":"

Description of the provisioning artifact output key.

" } }, "documentation":"

Provisioning artifact output.

" }, "ProvisioningArtifactOutputKey":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9]*" }, "ProvisioningArtifactOutputs":{ "type":"list", "member":{"shape":"ProvisioningArtifactOutput"}, "max":60 }, "ProvisioningArtifactParameter":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"

The parameter key.

" }, "DefaultValue":{ "shape":"DefaultValue", "documentation":"

The default value.

" }, "ParameterType":{ "shape":"ParameterType", "documentation":"

The parameter type.

" }, "IsNoEcho":{ "shape":"NoEcho", "documentation":"

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

" }, "Description":{ "shape":"Description", "documentation":"

The description of the parameter.

" }, "ParameterConstraints":{ "shape":"ParameterConstraints", "documentation":"

Constraints that the administrator has put on a parameter.

" } }, "documentation":"

Information about a parameter used to provision a product.

" }, "ProvisioningArtifactParameters":{ "type":"list", "member":{"shape":"ProvisioningArtifactParameter"} }, "ProvisioningArtifactPreferences":{ "type":"structure", "members":{ "StackSetAccounts":{ "shape":"StackSetAccounts", "documentation":"

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

Applicable only to a `CFN_STACKSET` provisioned product type.

" }, "StackSetRegions":{ "shape":"StackSetRegions", "documentation":"

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

Applicable only to a `CFN_STACKSET` provisioned product type.

" } }, "documentation":"

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.

" }, "ProvisioningArtifactProperties":{ "type":"structure", "members":{ "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

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

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

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

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

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

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

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

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

" }, "Type":{ "shape":"ProvisioningArtifactType", "documentation":"

The type of provisioning artifact.

- `CLOUD_FORMATION_TEMPLATE` - CloudFormation template

- `TERRAFORM_OPEN_SOURCE` - Terraform Open Source configuration file

- `TERRAFORM_CLOUD` - Terraform Cloud configuration file

- `EXTERNAL` - External configuration file

" }, "DisableTemplateValidation":{ "shape":"DisableTemplateValidation", "documentation":"

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

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

" } }, "documentation":"

Information about a provisioning artifact (also known as a version) for a product.

" }, "ProvisioningArtifactPropertyName":{ "type":"string", "enum":["Id"] }, "ProvisioningArtifactPropertyValue":{"type":"string"}, "ProvisioningArtifactSummaries":{ "type":"list", "member":{"shape":"ProvisioningArtifactSummary"} }, "ProvisioningArtifactSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name of the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The description of the provisioning artifact.

" }, "CreatedTime":{ "shape":"ProvisioningArtifactCreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "ProvisioningArtifactMetadata":{ "shape":"ProvisioningArtifactInfo", "documentation":"

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

" } }, "documentation":"

Summary information about a provisioning artifact (also known as a version) for a product.

" }, "ProvisioningArtifactType":{ "type":"string", "enum":[ "CLOUD_FORMATION_TEMPLATE", "MARKETPLACE_AMI", "MARKETPLACE_CAR", "TERRAFORM_OPEN_SOURCE", "TERRAFORM_CLOUD", "EXTERNAL" ] }, "ProvisioningArtifactView":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

Summary information about a product view.

" }, "ProvisioningArtifact":{ "shape":"ProvisioningArtifact", "documentation":"

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

" } }, "documentation":"

An object that contains summary information about a product view and a provisioning artifact.

" }, "ProvisioningArtifactViews":{ "type":"list", "member":{"shape":"ProvisioningArtifactView"} }, "ProvisioningArtifacts":{ "type":"list", "member":{"shape":"ProvisioningArtifact"} }, "ProvisioningParameter":{ "type":"structure", "members":{ "Key":{ "shape":"ParameterKey", "documentation":"

The parameter key.

" }, "Value":{ "shape":"ParameterValue", "documentation":"

The parameter value.

" } }, "documentation":"

Information about a parameter used to provision a product.

" }, "ProvisioningParameters":{ "type":"list", "member":{"shape":"ProvisioningParameter"} }, "ProvisioningPreferences":{ "type":"structure", "members":{ "StackSetAccounts":{ "shape":"StackSetAccounts", "documentation":"

One or more Amazon Web Services accounts where the provisioned product will be available.

Applicable only to a `CFN_STACKSET` provisioned product type.

The specified accounts should be within the list of accounts from the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.

If no values are specified, the default value is all acounts from the `STACKSET` constraint.

" }, "StackSetRegions":{ "shape":"StackSetRegions", "documentation":"

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a `CFN_STACKSET` provisioned product type.

The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.

If no values are specified, the default value is all Regions from the `STACKSET` constraint.

" }, "StackSetFailureToleranceCount":{ "shape":"StackSetFailureToleranceCount", "documentation":"

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_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.

The default value is `0` if no value is specified.

" }, "StackSetFailureTolerancePercentage":{ "shape":"StackSetFailureTolerancePercentage", "documentation":"

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_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.

" }, "StackSetMaxConcurrencyCount":{ "shape":"StackSetMaxConcurrencyCount", "documentation":"

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `StackSetFailureToleranceCount`. `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount`.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a `CFN_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.

" }, "StackSetMaxConcurrencyPercentage":{ "shape":"StackSetMaxConcurrencyPercentage", "documentation":"

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 `1` instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a `CFN_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.

" } }, "documentation":"

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.

" }, "RecordDetail":{ "type":"structure", "members":{ "RecordId":{ "shape":"Id", "documentation":"

The identifier of the record.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

The user-friendly name of the provisioned product.

" }, "Status":{ "shape":"RecordStatus", "documentation":"

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.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC time stamp of the creation time.

" }, "UpdatedTime":{ "shape":"UpdatedTime", "documentation":"

The time when the record was last updated.

" }, "ProvisionedProductType":{ "shape":"ProvisionedProductType", "documentation":"

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

" }, "RecordType":{ "shape":"RecordType", "documentation":"

The record type.

- `PROVISION_PRODUCT`

- `UPDATE_PROVISIONED_PRODUCT`

- `TERMINATE_PROVISIONED_PRODUCT`

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "PathId":{ "shape":"Id", "documentation":"

The path identifier.

" }, "RecordErrors":{ "shape":"RecordErrors", "documentation":"

The errors that occurred.

" }, "RecordTags":{ "shape":"RecordTags", "documentation":"

One or more tags.

" }, "LaunchRoleArn":{ "shape":"RoleArn", "documentation":"

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

" } }, "documentation":"

Information about a request operation.

" }, "RecordDetails":{ "type":"list", "member":{"shape":"RecordDetail"} }, "RecordError":{ "type":"structure", "members":{ "Code":{ "shape":"ErrorCode", "documentation":"

The numeric value of the error.

" }, "Description":{ "shape":"ErrorDescription", "documentation":"

The description of the error.

" } }, "documentation":"

The error code and description resulting from an operation.

" }, "RecordErrors":{ "type":"list", "member":{"shape":"RecordError"} }, "RecordOutput":{ "type":"structure", "members":{ "OutputKey":{ "shape":"OutputKey", "documentation":"

The output key.

" }, "OutputValue":{ "shape":"OutputValue", "documentation":"

The output value.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the output.

" } }, "documentation":"

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.

" }, "RecordOutputs":{ "type":"list", "member":{"shape":"RecordOutput"} }, "RecordStatus":{ "type":"string", "enum":[ "CREATED", "IN_PROGRESS", "IN_PROGRESS_IN_ERROR", "SUCCEEDED", "FAILED" ] }, "RecordTag":{ "type":"structure", "members":{ "Key":{ "shape":"RecordTagKey", "documentation":"

The key for this tag.

" }, "Value":{ "shape":"RecordTagValue", "documentation":"

The value for this tag.

" } }, "documentation":"

Information about a tag, which is a key-value pair.

" }, "RecordTagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "RecordTagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "RecordTags":{ "type":"list", "member":{"shape":"RecordTag"}, "max":50 }, "RecordType":{"type":"string"}, "Region":{"type":"string"}, "RejectPortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PortfolioShareType":{ "shape":"PortfolioShareType", "documentation":"

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`

" } } }, "RejectPortfolioShareOutput":{ "type":"structure", "members":{ } }, "Replacement":{ "type":"string", "enum":[ "TRUE", "FALSE", "CONDITIONAL" ] }, "Repository":{ "type":"string", "max":100, "min":1 }, "RepositoryArtifactPath":{ "type":"string", "max":4096, "min":1 }, "RepositoryBranch":{ "type":"string", "max":250, "min":1 }, "RequiresRecreation":{ "type":"string", "enum":[ "NEVER", "CONDITIONALLY", "ALWAYS" ] }, "ResourceARN":{ "type":"string", "max":150, "min":1 }, "ResourceAttribute":{ "type":"string", "enum":[ "PROPERTIES", "METADATA", "CREATIONPOLICY", "UPDATEPOLICY", "DELETIONPOLICY", "TAGS" ] }, "ResourceChange":{ "type":"structure", "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

The change action.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

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

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

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

" }, "ResourceType":{ "shape":"PlanResourceType", "documentation":"

The type of resource.

" }, "Replacement":{ "shape":"Replacement", "documentation":"

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

" }, "Scope":{ "shape":"Scope", "documentation":"

The change scope.

" }, "Details":{ "shape":"ResourceChangeDetails", "documentation":"

Information about the resource changes.

" } }, "documentation":"

Information about a resource change that will occur when a plan is executed.

" }, "ResourceChangeDetail":{ "type":"structure", "members":{ "Target":{ "shape":"ResourceTargetDefinition", "documentation":"

Information about the resource attribute to be modified.

" }, "Evaluation":{ "shape":"EvaluationType", "documentation":"

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.

" }, "CausingEntity":{ "shape":"CausingEntity", "documentation":"

The ID of the entity that caused the change.

" } }, "documentation":"

Information about a change to a resource attribute.

" }, "ResourceChangeDetails":{ "type":"list", "member":{"shape":"ResourceChangeDetail"} }, "ResourceChanges":{ "type":"list", "member":{"shape":"ResourceChange"} }, "ResourceDetail":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceDetailId", "documentation":"

The identifier of the resource.

" }, "ARN":{ "shape":"ResourceDetailARN", "documentation":"

The ARN of the resource.

" }, "Name":{ "shape":"ResourceDetailName", "documentation":"

The name of the resource.

" }, "Description":{ "shape":"ResourceDetailDescription", "documentation":"

The description of the resource.

" }, "CreatedTime":{ "shape":"ResourceDetailCreatedTime", "documentation":"

The creation time of the resource.

" } }, "documentation":"

Information about a resource.

" }, "ResourceDetailARN":{"type":"string"}, "ResourceDetailCreatedTime":{"type":"timestamp"}, "ResourceDetailDescription":{"type":"string"}, "ResourceDetailId":{"type":"string"}, "ResourceDetailName":{"type":"string"}, "ResourceDetails":{ "type":"list", "member":{"shape":"ResourceDetail"} }, "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource was not found.

", "exception":true }, "ResourceTargetDefinition":{ "type":"structure", "members":{ "Attribute":{ "shape":"ResourceAttribute", "documentation":"

The attribute to be changed.

" }, "Name":{ "shape":"PropertyName", "documentation":"

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

" }, "RequiresRecreation":{ "shape":"RequiresRecreation", "documentation":"

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

" } }, "documentation":"

Information about a change to a resource attribute.

" }, "ResourceType":{"type":"string"}, "RetainPhysicalResources":{"type":"boolean"}, "RoleArn":{ "type":"string", "max":1224, "min":1, "pattern":"arn:[a-z0-9-\\.]{1,63}:iam::[a-z0-9-\\.]{0,63}:role\\/.{0,1023}" }, "ScanProvisionedProductsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "ScanProvisionedProductsOutput":{ "type":"structure", "members":{ "ProvisionedProducts":{ "shape":"ProvisionedProductDetails", "documentation":"

Information about the provisioned products.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "Scope":{ "type":"list", "member":{"shape":"ResourceAttribute"} }, "SearchFilterKey":{"type":"string"}, "SearchFilterValue":{"type":"string"}, "SearchProductsAsAdminInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "Filters":{ "shape":"ProductViewFilters", "documentation":"

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

" }, "SortBy":{ "shape":"ProductViewSortBy", "documentation":"

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

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

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

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return with this call.

" }, "ProductSource":{ "shape":"ProductSource", "documentation":"

Access level of the source of the product.

" } } }, "SearchProductsAsAdminOutput":{ "type":"structure", "members":{ "ProductViewDetails":{ "shape":"ProductViewDetails", "documentation":"

Information about the product views.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "SearchProductsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Filters":{ "shape":"ProductViewFilters", "documentation":"

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

" }, "PageSize":{ "shape":"PageSizeMax100", "documentation":"

The maximum number of items to return with this call.

" }, "SortBy":{ "shape":"ProductViewSortBy", "documentation":"

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

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

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

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "SearchProductsOutput":{ "type":"structure", "members":{ "ProductViewSummaries":{ "shape":"ProductViewSummaries", "documentation":"

Information about the product views.

" }, "ProductViewAggregations":{ "shape":"ProductViewAggregations", "documentation":"

The product view aggregations.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "SearchProvisionedProductsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

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

" }, "Filters":{ "shape":"ProvisionedProductFilters", "documentation":"

The search filters.

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

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

" }, "SortBy":{ "shape":"SortField", "documentation":"

The sort field. If no value is specified, the results are not sorted. The valid values are `arn`, `id`, `name`, and `lastRecordId`.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

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

" }, "PageSize":{ "shape":"SearchProvisionedProductsPageSize", "documentation":"

The maximum number of items to return with this call.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "SearchProvisionedProductsOutput":{ "type":"structure", "members":{ "ProvisionedProducts":{ "shape":"ProvisionedProductAttributes", "documentation":"

Information about the provisioned products.

" }, "TotalResultsCount":{ "shape":"TotalResultsCount", "documentation":"

The number of provisioned products found.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

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

" } } }, "SearchProvisionedProductsPageSize":{ "type":"integer", "max":100, "min":0 }, "ServiceActionAssociation":{ "type":"structure", "required":[ "ServiceActionId", "ProductId", "ProvisioningArtifactId" ], "members":{ "ServiceActionId":{ "shape":"Id", "documentation":"

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

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier. For example, `prod-abcdzk7xy33qa`.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

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

" } }, "documentation":"

A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

" }, "ServiceActionAssociationErrorCode":{ "type":"string", "enum":[ "DUPLICATE_RESOURCE", "INTERNAL_FAILURE", "LIMIT_EXCEEDED", "RESOURCE_NOT_FOUND", "THROTTLING", "INVALID_PARAMETER" ] }, "ServiceActionAssociationErrorMessage":{ "type":"string", "max":1024, "min":1 }, "ServiceActionAssociations":{ "type":"list", "member":{"shape":"ServiceActionAssociation"}, "max":50, "min":1 }, "ServiceActionDefinitionKey":{ "type":"string", "enum":[ "Name", "Version", "AssumeRole", "Parameters" ] }, "ServiceActionDefinitionMap":{ "type":"map", "key":{"shape":"ServiceActionDefinitionKey"}, "value":{"shape":"ServiceActionDefinitionValue"}, "max":100, "min":1 }, "ServiceActionDefinitionType":{ "type":"string", "enum":["SSM_AUTOMATION"] }, "ServiceActionDefinitionValue":{ "type":"string", "max":1024, "min":1 }, "ServiceActionDescription":{ "type":"string", "max":1024 }, "ServiceActionDetail":{ "type":"structure", "members":{ "ServiceActionSummary":{ "shape":"ServiceActionSummary", "documentation":"

Summary information about the self-service action.

" }, "Definition":{ "shape":"ServiceActionDefinitionMap", "documentation":"

A map that defines the self-service action.

" } }, "documentation":"

An object containing detailed information about the self-service action.

" }, "ServiceActionName":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9_\\-.]*" }, "ServiceActionSummaries":{ "type":"list", "member":{"shape":"ServiceActionSummary"} }, "ServiceActionSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The self-service action identifier.

" }, "Name":{ "shape":"ServiceActionName", "documentation":"

The self-service action name.

" }, "Description":{ "shape":"ServiceActionDescription", "documentation":"

The self-service action description.

" }, "DefinitionType":{ "shape":"ServiceActionDefinitionType", "documentation":"

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

" } }, "documentation":"

Detailed information about the self-service action.

" }, "ShareDetails":{ "type":"structure", "members":{ "SuccessfulShares":{ "shape":"SuccessfulShares", "documentation":"

List of accounts for whom the operation succeeded.

" }, "ShareErrors":{ "shape":"ShareErrors", "documentation":"

List of errors.

" } }, "documentation":"

Information about the portfolio share operation.

" }, "ShareError":{ "type":"structure", "members":{ "Accounts":{ "shape":"Namespaces", "documentation":"

List of accounts impacted by the error.

" }, "Message":{ "shape":"Message", "documentation":"

Information about the error.

" }, "Error":{ "shape":"Error", "documentation":"

Error type that happened when processing the operation.

" } }, "documentation":"

Errors that occurred during the portfolio share operation.

" }, "ShareErrors":{ "type":"list", "member":{"shape":"ShareError"} }, "ShareStatus":{ "type":"string", "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "ERROR" ] }, "SortField":{"type":"string"}, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "SourceConnection":{ "type":"structure", "required":["ConnectionParameters"], "members":{ "Type":{ "shape":"SourceType", "documentation":"

The only supported `SourceConnection` type is Codestar.

" }, "ConnectionParameters":{ "shape":"SourceConnectionParameters", "documentation":"

The connection details based on the connection `Type`.

" } }, "documentation":"

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.

" }, "SourceConnectionDetail":{ "type":"structure", "members":{ "Type":{ "shape":"SourceType", "documentation":"

The only supported `SourceConnection` type is Codestar.

" }, "ConnectionParameters":{ "shape":"SourceConnectionParameters", "documentation":"

The connection details based on the connection `Type`.

" }, "LastSync":{ "shape":"LastSync", "documentation":"

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

- `LastSyncTime`

- `LastSyncStatus`

- `LastSyncStatusMessage`

- `LastSuccessfulSyncTime`

- `LastSuccessfulSyncProvisioningArtifactID`

" } }, "documentation":"

Provides details about the configured `SourceConnection`.

" }, "SourceConnectionParameters":{ "type":"structure", "members":{ "CodeStar":{ "shape":"CodeStarParameters", "documentation":"

Provides `ConnectionType` details.

" } }, "documentation":"

Provides connection details.

" }, "SourceProvisioningArtifactProperties":{ "type":"list", "member":{"shape":"SourceProvisioningArtifactPropertiesMap"} }, "SourceProvisioningArtifactPropertiesMap":{ "type":"map", "key":{"shape":"ProvisioningArtifactPropertyName"}, "value":{"shape":"ProvisioningArtifactPropertyValue"} }, "SourceRevision":{ "type":"string", "max":512, "min":1 }, "SourceType":{ "type":"string", "enum":["CODESTAR"] }, "StackInstance":{ "type":"structure", "members":{ "Account":{ "shape":"AccountId", "documentation":"

The name of the Amazon Web Services account that the stack instance is associated with.

" }, "Region":{ "shape":"Region", "documentation":"

The name of the Amazon Web Services Region that the stack instance is associated with.

" }, "StackInstanceStatus":{ "shape":"StackInstanceStatus", "documentation":"

The status of the stack instance, in terms of its synchronization with its associated stack set.

- `INOPERABLE`: A `DeleteStackInstances` operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further `UpdateStackSet` operations. You might need to perform a `DeleteStackInstances` operation, with `RetainStacks` set to true, to delete the stack instance, and then delete the stack manually.

- `OUTDATED`: The stack isn't currently up to date with the stack set because either the associated stack failed during a `CreateStackSet` or `UpdateStackSet` operation, or the stack was part of a `CreateStackSet` or `UpdateStackSet` operation that failed or was stopped before the stack was created or updated.

- `CURRENT`: The stack is currently up to date with the stack set.

" } }, "documentation":"

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.

" }, "StackInstanceStatus":{ "type":"string", "enum":[ "CURRENT", "OUTDATED", "INOPERABLE" ] }, "StackInstances":{ "type":"list", "member":{"shape":"StackInstance"} }, "StackSetAccounts":{ "type":"list", "member":{"shape":"AccountId"} }, "StackSetFailureToleranceCount":{ "type":"integer", "min":0 }, "StackSetFailureTolerancePercentage":{ "type":"integer", "max":100, "min":0 }, "StackSetMaxConcurrencyCount":{ "type":"integer", "min":1 }, "StackSetMaxConcurrencyPercentage":{ "type":"integer", "max":100, "min":1 }, "StackSetOperationType":{ "type":"string", "enum":[ "CREATE", "UPDATE", "DELETE" ] }, "StackSetRegions":{ "type":"list", "member":{"shape":"Region"} }, "Status":{ "type":"string", "enum":[ "AVAILABLE", "CREATING", "FAILED" ] }, "StatusDetail":{"type":"string"}, "StatusMessage":{ "type":"string", "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" }, "String":{"type":"string"}, "SuccessfulShares":{ "type":"list", "member":{"shape":"AccountId"} }, "SupportDescription":{ "type":"string", "max":8191 }, "SupportEmail":{ "type":"string", "max":254 }, "SupportUrl":{ "type":"string", "max":2083 }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The tag key.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value for this key.

" } }, "documentation":"

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagOptionActive":{"type":"boolean"}, "TagOptionDetail":{ "type":"structure", "members":{ "Key":{ "shape":"TagOptionKey", "documentation":"

The TagOption key.

" }, "Value":{ "shape":"TagOptionValue", "documentation":"

The TagOption value.

" }, "Active":{ "shape":"TagOptionActive", "documentation":"

The TagOption active state.

" }, "Id":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" }, "Owner":{ "shape":"Owner", "documentation":"

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

" } }, "documentation":"

Information about a TagOption.

" }, "TagOptionDetails":{ "type":"list", "member":{"shape":"TagOptionDetail"} }, "TagOptionId":{ "type":"string", "max":100, "min":1 }, "TagOptionKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagOptionNotMigratedException":{ "type":"structure", "members":{ }, "documentation":"

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.

", "exception":true }, "TagOptionSummaries":{ "type":"list", "member":{"shape":"TagOptionSummary"} }, "TagOptionSummary":{ "type":"structure", "members":{ "Key":{ "shape":"TagOptionKey", "documentation":"

The TagOption key.

" }, "Values":{ "shape":"TagOptionValues", "documentation":"

The TagOption value.

" } }, "documentation":"

Summary information about a TagOption.

" }, "TagOptionValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagOptionValues":{ "type":"list", "member":{"shape":"TagOptionValue"} }, "TagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":50 }, "TerminateProvisionedProductInput":{ "type":"structure", "required":["TerminateToken"], "members":{ "ProvisionedProductName":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

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

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

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

" }, "TerminateToken":{ "shape":"IdempotencyToken", "documentation":"

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.

", "idempotencyToken":true }, "IgnoreErrors":{ "shape":"IgnoreErrors", "documentation":"

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

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "RetainPhysicalResources":{ "shape":"RetainPhysicalResources", "documentation":"

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

" } } }, "TerminateProvisionedProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Information about the result of this request.

" } } }, "TotalResultsCount":{"type":"integer"}, "UniqueTagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$" }, "UniqueTagResourceIdentifier":{ "type":"structure", "members":{ "Key":{ "shape":"UniqueTagKey", "documentation":"

A unique key that's attached to a resource.

" }, "Value":{ "shape":"UniqueTagValue", "documentation":"

A unique value that's attached to a resource.

" } }, "documentation":"

The unique key-value pair for a tag that identifies provisioned product resources.

" }, "UniqueTagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)$" }, "UpdateConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The updated description of the constraint.

" }, "Parameters":{ "shape":"ConstraintParameters", "documentation":"

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

LAUNCH

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

  Specify the `RoleArn` property as follows:

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

  Specify the `LocalRoleName` property as follows:

  `{\"LocalRoleName\": \"SCBasicLaunchRole\"}`

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

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

  You cannot have both a `LAUNCH` and a `STACKSET` constraint.

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

NOTIFICATION

  Specify the `NotificationArns` property as follows:

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

RESOURCE_UPDATE

  Specify the `TagUpdatesOnProvisionedProduct` property as follows:

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

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

STACKSET

  Specify the `Parameters` property as follows:

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

  You cannot have both a `LAUNCH` and a `STACKSET` constraint.

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

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

TEMPLATE

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

" } } }, "UpdateConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

Information about the constraint.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The constraint parameters.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "UpdatePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The updated description of the portfolio.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The updated name of the portfolio provider.

" }, "AddTags":{ "shape":"AddTags", "documentation":"

The tags to add.

" }, "RemoveTags":{ "shape":"TagKeys", "documentation":"

The tags to remove.

" } } }, "UpdatePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

Information about the portfolio.

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the portfolio.

" } } }, "UpdatePortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The unique identifier of the portfolio for which the share will be updated.

" }, "AccountId":{ "shape":"AccountId", "documentation":"

The Amazon Web Services account Id of the recipient account. This field is required when updating an external account to account type share.

" }, "OrganizationNode":{"shape":"OrganizationNode"}, "ShareTagOptions":{ "shape":"NullableBoolean", "documentation":"

Enables or disables `TagOptions` sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.

" }, "SharePrincipals":{ "shape":"NullableBoolean", "documentation":"

A flag to enables or disables `Principals` sharing in the portfolio. If this field is not provided, the current state of the `Principals` sharing on the portfolio share will not be modified.

" } } }, "UpdatePortfolioShareOutput":{ "type":"structure", "members":{ "PortfolioShareToken":{ "shape":"Id", "documentation":"

The token that tracks the status of the `UpdatePortfolioShare` operation for external account to account or organizational type sharing.

" }, "Status":{ "shape":"ShareStatus", "documentation":"

The status of `UpdatePortfolioShare` operation. You can also obtain the operation status using `DescribePortfolioShareStatus` API.

" } } }, "UpdateProductInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "Id":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The updated product name.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

The updated owner of the product.

" }, "Description":{ "shape":"ProductViewShortDescription", "documentation":"

The updated description of the product.

" }, "Distributor":{ "shape":"ProductViewOwner", "documentation":"

The updated distributor of the product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

The updated support description for the product.

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

The updated support email for the product.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

The updated support URL for the product.

" }, "AddTags":{ "shape":"AddTags", "documentation":"

The tags to add to the product.

" }, "RemoveTags":{ "shape":"TagKeys", "documentation":"

The tags to remove from the product.

" }, "SourceConnection":{ "shape":"SourceConnection", "documentation":"

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 `SourceConnection` parameter consists of the following sub-fields.

- `Type`

- `ConnectionParamters`

" } } }, "UpdateProductOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

Information about the product view.

" }, "Tags":{ "shape":"Tags", "documentation":"

Information about the tags associated with the product.

" } } }, "UpdateProvisionedProductInput":{ "type":"structure", "required":["UpdateToken"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

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

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

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

" }, "ProductId":{ "shape":"Id", "documentation":"

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

" }, "ProductName":{ "shape":"ProductViewName", "documentation":"

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

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProvisioningArtifactName":{ "shape":"ProvisioningArtifactName", "documentation":"

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

" }, "PathId":{ "shape":"Id", "documentation":"

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":{ "shape":"PortfolioDisplayName", "documentation":"

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

" }, "ProvisioningParameters":{ "shape":"UpdateProvisioningParameters", "documentation":"

The new parameters.

" }, "ProvisioningPreferences":{ "shape":"UpdateProvisioningPreferences", "documentation":"

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

" }, "Tags":{ "shape":"Tags", "documentation":"

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

" }, "UpdateToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that uniquely identifies the provisioning update request.

", "idempotencyToken":true } } }, "UpdateProvisionedProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Information about the result of the request.

" } } }, "UpdateProvisionedProductPropertiesInput":{ "type":"structure", "required":[ "ProvisionedProductId", "ProvisionedProductProperties", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the provisioned product.

" }, "ProvisionedProductProperties":{ "shape":"ProvisionedProductProperties", "documentation":"

A map that contains the provisioned product properties to be updated.

The `LAUNCH_ROLE` key accepts role ARNs. This key allows an administrator to call `UpdateProvisionedProductProperties` to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as `UpdateProvisionedProduct`, `TerminateProvisionedProduct`, or `ExecuteProvisionedProductServiceAction`. Only a role ARN is valid. A user ARN is invalid.

The `OWNER` key accepts user ARNs, 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 `ListRecordHistory` API. The new owner can describe all past records for the provisioned product using the `DescribeRecord` API. The previous owner can no longer use `DescribeRecord`, but can still see the product's history from when he was an owner using `ListRecordHistory`.

If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that uniquely identifies the provisioning product update request.

", "idempotencyToken":true } } }, "UpdateProvisionedProductPropertiesOutput":{ "type":"structure", "members":{ "ProvisionedProductId":{ "shape":"Id", "documentation":"

The provisioned product identifier.

" }, "ProvisionedProductProperties":{ "shape":"ProvisionedProductProperties", "documentation":"

A map that contains the properties updated.

" }, "RecordId":{ "shape":"Id", "documentation":"

The identifier of the record.

" }, "Status":{ "shape":"RecordStatus", "documentation":"

The status of the request.

" } } }, "UpdateProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The updated name of the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The updated description of the provisioning artifact.

" }, "Active":{ "shape":"ProvisioningArtifactActive", "documentation":"

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.

" }, "Guidance":{ "shape":"ProvisioningArtifactGuidance", "documentation":"

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

The `DEFAULT` value indicates that the product version is active.

The administrator can set the guidance to `DEPRECATED` to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

" } } }, "UpdateProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

Information about the provisioning artifact.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

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

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "UpdateProvisioningParameter":{ "type":"structure", "members":{ "Key":{ "shape":"ParameterKey", "documentation":"

The parameter key.

" }, "Value":{ "shape":"ParameterValue", "documentation":"

The parameter value.

" }, "UsePreviousValue":{ "shape":"UsePreviousValue", "documentation":"

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

" } }, "documentation":"

The parameter key-value pair used to update a provisioned product.

" }, "UpdateProvisioningParameters":{ "type":"list", "member":{"shape":"UpdateProvisioningParameter"} }, "UpdateProvisioningPreferences":{ "type":"structure", "members":{ "StackSetAccounts":{ "shape":"StackSetAccounts", "documentation":"

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.

" }, "StackSetRegions":{ "shape":"StackSetRegions", "documentation":"

One or more Amazon Web Services Regions where the provisioned product will be available.

Applicable only to a `CFN_STACKSET` provisioned product type.

The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.

If no values are specified, the default value is all Regions from the `STACKSET` constraint.

" }, "StackSetFailureToleranceCount":{ "shape":"StackSetFailureToleranceCount", "documentation":"

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_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.

The default value is `0` if no value is specified.

" }, "StackSetFailureTolerancePercentage":{ "shape":"StackSetFailureTolerancePercentage", "documentation":"

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_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.

" }, "StackSetMaxConcurrencyCount":{ "shape":"StackSetMaxConcurrencyCount", "documentation":"

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `StackSetFailureToleranceCount`. `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount`.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a `CFN_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.

" }, "StackSetMaxConcurrencyPercentage":{ "shape":"StackSetMaxConcurrencyPercentage", "documentation":"

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 `1` instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Applicable only to a `CFN_STACKSET` provisioned product type.

Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.

" }, "StackSetOperationType":{ "shape":"StackSetOperationType", "documentation":"

Determines what action Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is `UPDATE` if nothing is specified.

Applicable only to a `CFN_STACKSET` provisioned product type.

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.

" } }, "documentation":"

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

" }, "UpdateServiceActionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The self-service action identifier.

" }, "Name":{ "shape":"ServiceActionName", "documentation":"

The self-service action name.

" }, "Definition":{ "shape":"ServiceActionDefinitionMap", "documentation":"

A map that defines the self-service action.

" }, "Description":{ "shape":"ServiceActionDescription", "documentation":"

The self-service action description.

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code.

- `jp` - Japanese

- `zh` - Chinese

" } } }, "UpdateServiceActionOutput":{ "type":"structure", "members":{ "ServiceActionDetail":{ "shape":"ServiceActionDetail", "documentation":"

Detailed information about the self-service action.

" } } }, "UpdateTagOptionInput":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TagOptionId", "documentation":"

The TagOption identifier.

" }, "Value":{ "shape":"TagOptionValue", "documentation":"

The updated value.

" }, "Active":{ "shape":"TagOptionActive", "documentation":"

The updated active state.

" } } }, "UpdateTagOptionOutput":{ "type":"structure", "members":{ "TagOptionDetail":{ "shape":"TagOptionDetail", "documentation":"

Information about the TagOption.

" } } }, "UpdatedTime":{"type":"timestamp"}, "UsageInstruction":{ "type":"structure", "members":{ "Type":{ "shape":"InstructionType", "documentation":"

The usage instruction type for the value.

" }, "Value":{ "shape":"InstructionValue", "documentation":"

The usage instruction value for this type.

" } }, "documentation":"

Additional information provided by the administrator.

" }, "UsageInstructions":{ "type":"list", "member":{"shape":"UsageInstruction"} }, "UsePreviousValue":{"type":"boolean"}, "UserArn":{"type":"string"}, "UserArnSession":{"type":"string"}, "Verbose":{"type":"boolean"} }, "documentation":"Service Catalog

Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.

" }