{
"version": "2.0",
"service": "
Overview
AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, be familiar with the terminology discussed in AWS Service Catalog Concepts.
Additional Resources
", "operations": { "AcceptPortfolioShare": "Accepts an offer to share a portfolio.
", "AssociatePrincipalWithPortfolio": "Associates the specified principal ARN with the specified portfolio.
", "AssociateProductWithPortfolio": "Associates a product with a portfolio.
", "AssociateTagOptionWithResource": "Associate a TagOption identifier with a resource identifier.
", "CopyProduct": "Copies the specified source product to the specified target product or a new product.
You can copy the product to the same account or another account. You can copy the product to the same region or another region.
This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.
", "CreateConstraint": "Creates a new constraint. For more information, see Using Constraints.
", "CreatePortfolio": "Creates a new portfolio.
", "CreatePortfolioShare": "Creates a new portfolio share.
", "CreateProduct": "Creates a new product.
", "CreateProvisioningArtifact": "Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
", "CreateTagOption": "Create a new TagOption.
", "DeleteConstraint": "Deletes the specified constraint.
", "DeletePortfolio": "Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.
", "DeletePortfolioShare": "Deletes the specified portfolio share.
", "DeleteProduct": "Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.
", "DeleteProvisioningArtifact": "Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).
", "DescribeConstraint": "Retrieves detailed information for a specified constraint.
", "DescribeCopyProductStatus": "Describes the status of the specified copy product operation.
", "DescribePortfolio": "Retrieves detailed information and any tags associated with the specified portfolio.
", "DescribeProduct": "Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input ProductId
instead of ProductViewId
.
Retrieves information about a specified product, run with administrator access.
", "DescribeProductView": "Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId
instead of ProductId
.
Retrieve detailed information about the provisioned product.
", "DescribeProvisioningArtifact": "Retrieves detailed information about the specified provisioning artifact.
", "DescribeProvisioningParameters": "Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters
parameters available to call the ProvisionProduct operation for the specified product.
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 the ProvisionProduct
operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct
with empty TagOption values cause the error \"Parameter validation failed: Missing required parameter in Tags[N]:Value \". Calls to ProvisionProduct
with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value \"sc-tagoption-conflict-portfolioId-productId
\".
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
", "DescribeTagOption": "Describes a TagOption.
", "DisassociatePrincipalFromPortfolio": "Disassociates a previously associated principal ARN from a specified portfolio.
", "DisassociateProductFromPortfolio": "Disassociates the specified product from the specified portfolio.
", "DisassociateTagOptionFromResource": "Disassociates a TagOption from a resource.
", "ListAcceptedPortfolioShares": "Lists details of all portfolios for which sharing was accepted by this account.
", "ListConstraintsForPortfolio": "Retrieves detailed constraint information for the specified portfolio and product.
", "ListLaunchPaths": "Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
", "ListPortfolioAccess": "Lists the account IDs that have been authorized sharing of the specified portfolio.
", "ListPortfolios": "Lists all portfolios in the catalog.
", "ListPortfoliosForProduct": "Lists all portfolios that the specified product is associated with.
", "ListPrincipalsForPortfolio": "Lists all principal ARNs associated with the specified portfolio.
", "ListProvisioningArtifacts": "Lists all provisioning artifacts associated with the specified product.
", "ListRecordHistory": "Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
", "ListResourcesForTagOption": "Lists resources associated with a TagOption.
", "ListTagOptions": "Lists detailed TagOptions information.
", "ProvisionProduct": "Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation. The error \"Parameter validation failed: Missing required parameter in Tags[N]:Value\" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters
call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.
Rejects an offer to share a portfolio.
", "ScanProvisionedProducts": "Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
", "SearchProducts": "Returns a paginated list all of the Products
objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView.
", "SearchProductsAsAdmin": "Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.
", "TerminateProvisionedProduct": "Requests termination of an existing ProvisionedProduct object. If there are Tags
associated with the object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
", "UpdateConstraint": "Updates an existing constraint.
", "UpdatePortfolio": "Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.
", "UpdateProduct": "Updates an existing product.
", "UpdateProvisionedProduct": "Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
", "UpdateProvisioningArtifact": "Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.
", "UpdateTagOption": "Updates an existing TagOption.
" }, "shapes": { "AcceptLanguage": { "base": null, "refs": { "AcceptPortfolioShareInput$AcceptLanguage": "The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The language code.
en
- English (default)
jp
- Japanese
zh
- Chinese
The access level to limit results.
", "refs": { "ListRecordHistoryInput$AccessLevelFilter": "The access level for obtaining results. If left unspecified, User
level access is used.
The access level for obtaining results. If left unspecified, User
level access is used.
Specifies the access level.
Account
allows results at the account level.
Role
allows results based on the federated role of the specified user.
User
allows results limited to the specified user.
Specifies the user to which the access level applies. A value of Self
is currently supported.
The owner of the constraint.
", "CreatePortfolioShareInput$AccountId": "The account ID with which to share the portfolio.
", "DeletePortfolioShareInput$AccountId": "The account ID associated with the share to delete.
" } }, "AccountIds": { "base": null, "refs": { "ListPortfolioAccessOutput$AccountIds": "List of account IDs associated with access to the portfolio.
" } }, "AddTags": { "base": null, "refs": { "CreatePortfolioInput$Tags": "Tags to associate with the new portfolio.
", "CreateProductInput$Tags": "Tags to associate with the new product.
", "UpdatePortfolioInput$AddTags": "Tags to add to the existing list of tags associated with the portfolio.
", "UpdateProductInput$AddTags": "Tags to add to the existing list of tags associated with the product.
" } }, "AllowedValue": { "base": null, "refs": { "AllowedValues$member": null } }, "AllowedValues": { "base": null, "refs": { "ParameterConstraints$AllowedValues": "The values that the administrator has allowed for the parameter.
" } }, "ApproximateCount": { "base": null, "refs": { "ProductViewAggregationValue$ApproximateCount": "An approximate count of the products that match the value.
" } }, "AssociatePrincipalWithPortfolioInput": { "base": null, "refs": { } }, "AssociatePrincipalWithPortfolioOutput": { "base": null, "refs": { } }, "AssociateProductWithPortfolioInput": { "base": null, "refs": { } }, "AssociateProductWithPortfolioOutput": { "base": null, "refs": { } }, "AssociateTagOptionWithResourceInput": { "base": null, "refs": { } }, "AssociateTagOptionWithResourceOutput": { "base": null, "refs": { } }, "AttributeValue": { "base": null, "refs": { "ProductViewAggregationValue$Value": "The value of the product view aggregation.
" } }, "ConstraintDescription": { "base": null, "refs": { "ConstraintDetail$Description": "The text description of the constraint.
", "ConstraintSummary$Description": "The text description of the constraint.
", "CreateConstraintInput$Description": "The text description of the constraint.
", "UpdateConstraintInput$Description": "The updated text description of the constraint.
" } }, "ConstraintDetail": { "base": "Detailed constraint information.
", "refs": { "ConstraintDetails$member": null, "CreateConstraintOutput$ConstraintDetail": "The resulting detailed constraint information.
", "DescribeConstraintOutput$ConstraintDetail": "Detailed constraint information.
", "UpdateConstraintOutput$ConstraintDetail": "The resulting detailed constraint information.
" } }, "ConstraintDetails": { "base": null, "refs": { "ListConstraintsForPortfolioOutput$ConstraintDetails": "List of detailed constraint information objects.
" } }, "ConstraintParameters": { "base": null, "refs": { "CreateConstraintInput$Parameters": "The constraint parameters. Expected values vary depending on which Type is specified. For more information, see the Examples section.
For Type LAUNCH
, the RoleArn
property is required.
For Type NOTIFICATION
, the NotificationArns
property is required.
For Type TEMPLATE
, the Rules
property is required.
The resulting constraint parameters.
", "DescribeConstraintOutput$ConstraintParameters": "The current parameters associated with the specified constraint.
", "UpdateConstraintOutput$ConstraintParameters": "The resulting updated constraint parameters.
" } }, "ConstraintSummaries": { "base": null, "refs": { "DescribeProvisioningParametersOutput$ConstraintSummaries": "The list of constraint summaries that apply to provisioning this product.
", "LaunchPathSummary$ConstraintSummaries": "List of constraints on the portfolio-product relationship.
" } }, "ConstraintSummary": { "base": "An administrator-specified constraint to apply when provisioning a product.
", "refs": { "ConstraintSummaries$member": null } }, "ConstraintType": { "base": null, "refs": { "ConstraintDetail$Type": "The type of the constraint.
", "ConstraintSummary$Type": "The type of the constraint.
", "CreateConstraintInput$Type": "The type of the constraint. Case-sensitive valid values are: LAUNCH
, NOTIFICATION
, or TEMPLATE
.
The copy options. If the value is CopyTags
, the tags from the source product are copied to the target product.
The status of the copy product operation.
" } }, "CreateConstraintInput": { "base": null, "refs": { } }, "CreateConstraintOutput": { "base": null, "refs": { } }, "CreatePortfolioInput": { "base": null, "refs": { } }, "CreatePortfolioOutput": { "base": null, "refs": { } }, "CreatePortfolioShareInput": { "base": null, "refs": { } }, "CreatePortfolioShareOutput": { "base": null, "refs": { } }, "CreateProductInput": { "base": null, "refs": { } }, "CreateProductOutput": { "base": null, "refs": { } }, "CreateProvisioningArtifactInput": { "base": null, "refs": { } }, "CreateProvisioningArtifactOutput": { "base": null, "refs": { } }, "CreateTagOptionInput": { "base": null, "refs": { } }, "CreateTagOptionOutput": { "base": null, "refs": { } }, "CreatedTime": { "base": null, "refs": { "ProductViewDetail$CreatedTime": "The UTC timestamp of the creation time.
", "ProvisionedProductDetail$CreatedTime": "The UTC timestamp of the creation time.
", "RecordDetail$CreatedTime": "The UTC timestamp of the creation time.
" } }, "CreationTime": { "base": null, "refs": { "PortfolioDetail$CreatedTime": "The UTC timestamp of the creation time.
", "ProvisioningArtifactDetail$CreatedTime": "The UTC timestamp of the creation time.
" } }, "DefaultValue": { "base": null, "refs": { "ProvisioningArtifactParameter$DefaultValue": "The default value for this parameter.
" } }, "DeleteConstraintInput": { "base": null, "refs": { } }, "DeleteConstraintOutput": { "base": null, "refs": { } }, "DeletePortfolioInput": { "base": null, "refs": { } }, "DeletePortfolioOutput": { "base": null, "refs": { } }, "DeletePortfolioShareInput": { "base": null, "refs": { } }, "DeletePortfolioShareOutput": { "base": null, "refs": { } }, "DeleteProductInput": { "base": null, "refs": { } }, "DeleteProductOutput": { "base": null, "refs": { } }, "DeleteProvisioningArtifactInput": { "base": null, "refs": { } }, "DeleteProvisioningArtifactOutput": { "base": null, "refs": { } }, "DescribeConstraintInput": { "base": null, "refs": { } }, "DescribeConstraintOutput": { "base": null, "refs": { } }, "DescribeCopyProductStatusInput": { "base": null, "refs": { } }, "DescribeCopyProductStatusOutput": { "base": null, "refs": { } }, "DescribePortfolioInput": { "base": null, "refs": { } }, "DescribePortfolioOutput": { "base": null, "refs": { } }, "DescribeProductAsAdminInput": { "base": null, "refs": { } }, "DescribeProductAsAdminOutput": { "base": null, "refs": { } }, "DescribeProductInput": { "base": null, "refs": { } }, "DescribeProductOutput": { "base": null, "refs": { } }, "DescribeProductViewInput": { "base": null, "refs": { } }, "DescribeProductViewOutput": { "base": null, "refs": { } }, "DescribeProvisionedProductInput": { "base": null, "refs": { } }, "DescribeProvisionedProductOutput": { "base": null, "refs": { } }, "DescribeProvisioningArtifactInput": { "base": null, "refs": { } }, "DescribeProvisioningArtifactOutput": { "base": null, "refs": { } }, "DescribeProvisioningParametersInput": { "base": null, "refs": { } }, "DescribeProvisioningParametersOutput": { "base": null, "refs": { } }, "DescribeRecordInput": { "base": null, "refs": { } }, "DescribeRecordOutput": { "base": null, "refs": { } }, "DescribeTagOptionInput": { "base": null, "refs": { } }, "DescribeTagOptionOutput": { "base": null, "refs": { } }, "Description": { "base": null, "refs": { "ProvisioningArtifactParameter$Description": "The text description of the parameter.
", "RecordOutput$Description": "The text description of the output.
" } }, "DisassociatePrincipalFromPortfolioInput": { "base": null, "refs": { } }, "DisassociatePrincipalFromPortfolioOutput": { "base": null, "refs": { } }, "DisassociateProductFromPortfolioInput": { "base": null, "refs": { } }, "DisassociateProductFromPortfolioOutput": { "base": null, "refs": { } }, "DisassociateTagOptionFromResourceInput": { "base": null, "refs": { } }, "DisassociateTagOptionFromResourceOutput": { "base": null, "refs": { } }, "DuplicateResourceException": { "base": "The specified resource is a duplicate.
", "refs": { } }, "ErrorCode": { "base": null, "refs": { "RecordError$Code": "The numeric value of the error.
" } }, "ErrorDescription": { "base": null, "refs": { "RecordError$Description": "The text description of the error.
" } }, "HasDefaultPath": { "base": null, "refs": { "ProductViewSummary$HasDefaultPath": "A value of false
indicates that the product does not have a default path, while a value of true
indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
The portfolio identifier.
", "AssociatePrincipalWithPortfolioInput$PortfolioId": "The portfolio identifier.
", "AssociateProductWithPortfolioInput$ProductId": "The product identifier.
", "AssociateProductWithPortfolioInput$PortfolioId": "The portfolio identifier.
", "AssociateProductWithPortfolioInput$SourcePortfolioId": "The identifier of the source portfolio to use with this association.
", "ConstraintDetail$ConstraintId": "The identifier of the constraint.
", "CopyProductInput$TargetProductId": "The ID of the target product. By default, a new product is created.
", "CopyProductOutput$CopyProductToken": "A unique token to pass to DescribeCopyProductStatus
to track the progress of the operation.
The portfolio identifier.
", "CreateConstraintInput$ProductId": "The product identifier.
", "CreatePortfolioShareInput$PortfolioId": "The portfolio identifier.
", "CreateProvisioningArtifactInput$ProductId": "The product identifier.
", "DeleteConstraintInput$Id": "The identifier of the constraint to delete.
", "DeletePortfolioInput$Id": "The identifier of the portfolio for the delete request.
", "DeletePortfolioShareInput$PortfolioId": "The portfolio identifier.
", "DeleteProductInput$Id": "The identifier of the product for the delete request.
", "DeleteProvisioningArtifactInput$ProductId": "The product identifier.
", "DeleteProvisioningArtifactInput$ProvisioningArtifactId": "The identifier of the provisioning artifact for the delete request. This is sometimes referred to as the product version.
", "DescribeConstraintInput$Id": "The identifier of the constraint.
", "DescribeCopyProductStatusInput$CopyProductToken": "The token returned from the call to CopyProduct
that initiated the operation.
The ID of the copied product.
", "DescribePortfolioInput$Id": "The identifier of the portfolio for which to retrieve information.
", "DescribeProductAsAdminInput$Id": "The identifier of the product for which to retrieve information.
", "DescribeProductInput$Id": "The ProductId
of the product to describe.
The ProductViewId
of the product to describe.
The provisioned product identifier.
", "DescribeProvisioningArtifactInput$ProvisioningArtifactId": "The identifier of the provisioning artifact. This is sometimes referred to as the product version.
", "DescribeProvisioningArtifactInput$ProductId": "The product identifier.
", "DescribeProvisioningParametersInput$ProductId": "The product identifier.
", "DescribeProvisioningParametersInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
", "DescribeProvisioningParametersInput$PathId": "The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
", "DescribeRecordInput$Id": "The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId
obtained from the request operation's response.
The portfolio identifier.
", "DisassociateProductFromPortfolioInput$ProductId": "The product identifier.
", "DisassociateProductFromPortfolioInput$PortfolioId": "The portfolio identifier.
", "LaunchPathSummary$Id": "The unique identifier of the product path.
", "ListConstraintsForPortfolioInput$PortfolioId": "The portfolio identifier.
", "ListConstraintsForPortfolioInput$ProductId": "The product identifier.
", "ListLaunchPathsInput$ProductId": "The product identifier. Identifies the product for which to retrieve LaunchPathSummaries
information.
The portfolio identifier.
", "ListPortfoliosForProductInput$ProductId": "The product identifier.
", "ListPrincipalsForPortfolioInput$PortfolioId": "The portfolio identifier.
", "ListProvisioningArtifactsInput$ProductId": "The product identifier.
", "PortfolioDetail$Id": "The identifier for the portfolio.
", "ProductViewSummary$Id": "The product view identifier.
", "ProductViewSummary$ProductId": "The product identifier.
", "ProvisionProductInput$ProductId": "The product identifier.
", "ProvisionProductInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
", "ProvisionProductInput$PathId": "The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
", "ProvisioningArtifact$Id": "The identifier for the artifact. This is sometimes referred to as the product version.
", "ProvisioningArtifactDetail$Id": "The identifier of the provisioning artifact. This is sometimes referred to as the product version.
", "ProvisioningArtifactSummary$Id": "The identifier of the provisioning artifact.
", "RecordDetail$RecordId": "The identifier of the ProvisionedProduct object record.
", "RecordDetail$ProvisionedProductId": "The identifier of the ProvisionedProduct object.
", "RecordDetail$ProductId": "The product identifier.
", "RecordDetail$ProvisioningArtifactId": "The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
", "RecordDetail$PathId": "The identifier of the path for this product's provisioning.
", "RejectPortfolioShareInput$PortfolioId": "The portfolio identifier.
", "SearchProductsAsAdminInput$PortfolioId": "The portfolio identifier.
", "TerminateProvisionedProductInput$ProvisionedProductId": "The identifier of the ProvisionedProduct object to terminate. Specify either ProvisionedProductName
or ProvisionedProductId
, but not both.
The identifier of the constraint to update.
", "UpdatePortfolioInput$Id": "The identifier of the portfolio for the update request.
", "UpdateProductInput$Id": "The identifier of the product for the update request.
", "UpdateProvisionedProductInput$ProvisionedProductId": "The identifier of the ProvisionedProduct object to update. Specify either ProvisionedProductName
or ProvisionedProductId
, but not both.
The identifier of the ProvisionedProduct object.
", "UpdateProvisionedProductInput$ProvisioningArtifactId": "The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
", "UpdateProvisionedProductInput$PathId": "The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
", "UpdateProvisioningArtifactInput$ProductId": "The product identifier.
", "UpdateProvisioningArtifactInput$ProvisioningArtifactId": "The identifier of the provisioning artifact for the update request. This is sometimes referred to as the product version.
" } }, "IdempotencyToken": { "base": null, "refs": { "CopyProductInput$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "CreateConstraintInput$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "CreatePortfolioInput$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "CreateProductInput$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "CreateProvisioningArtifactInput$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "ProvisionProductInput$ProvisionToken": "An idempotency token that uniquely identifies the provisioning request.
", "ProvisionedProductDetail$IdempotencyToken": "A token to disambiguate duplicate requests. You can use the same input in multiple requests, provided that you also specify a different idempotency token for each request.
", "TerminateProvisionedProductInput$TerminateToken": "An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return ResourceNotFound regardless of the value of TerminateToken
.
The idempotency token that uniquely identifies the provisioning update request.
" } }, "IgnoreErrors": { "base": null, "refs": { "TerminateProvisionedProductInput$IgnoreErrors": "If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources.
" } }, "InstructionType": { "base": null, "refs": { "UsageInstruction$Type": "The usage instruction type for the value.
" } }, "InstructionValue": { "base": null, "refs": { "UsageInstruction$Value": "The usage instruction value for this type.
" } }, "InvalidParametersException": { "base": "One or more parameters provided to the operation are invalid.
", "refs": { } }, "InvalidStateException": { "base": "An attempt was made to modify a resource that is in an invalid state. Inspect the resource you are using for this operation to ensure that all resource states are valid before retrying the operation.
", "refs": { } }, "LastRequestId": { "base": null, "refs": { "ProvisionedProductDetail$LastRecordId": "The record identifier of the last request performed on this ProvisionedProduct object.
" } }, "LaunchPathSummaries": { "base": null, "refs": { "ListLaunchPathsOutput$LaunchPathSummaries": "List of launch path information summaries for the specified PageToken
.
Summary information about a path for a user to have access to a specified product.
", "refs": { "LaunchPathSummaries$member": null } }, "LimitExceededException": { "base": "The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.
", "refs": { } }, "ListAcceptedPortfolioSharesInput": { "base": null, "refs": { } }, "ListAcceptedPortfolioSharesOutput": { "base": null, "refs": { } }, "ListConstraintsForPortfolioInput": { "base": null, "refs": { } }, "ListConstraintsForPortfolioOutput": { "base": null, "refs": { } }, "ListLaunchPathsInput": { "base": null, "refs": { } }, "ListLaunchPathsOutput": { "base": null, "refs": { } }, "ListPortfolioAccessInput": { "base": null, "refs": { } }, "ListPortfolioAccessOutput": { "base": null, "refs": { } }, "ListPortfoliosForProductInput": { "base": null, "refs": { } }, "ListPortfoliosForProductOutput": { "base": null, "refs": { } }, "ListPortfoliosInput": { "base": null, "refs": { } }, "ListPortfoliosOutput": { "base": null, "refs": { } }, "ListPrincipalsForPortfolioInput": { "base": null, "refs": { } }, "ListPrincipalsForPortfolioOutput": { "base": null, "refs": { } }, "ListProvisioningArtifactsInput": { "base": null, "refs": { } }, "ListProvisioningArtifactsOutput": { "base": null, "refs": { } }, "ListRecordHistoryInput": { "base": null, "refs": { } }, "ListRecordHistoryOutput": { "base": null, "refs": { } }, "ListRecordHistorySearchFilter": { "base": "The search filter to limit results when listing request history records.
", "refs": { "ListRecordHistoryInput$SearchFilter": "The filter to limit search results.
" } }, "ListResourcesForTagOptionInput": { "base": null, "refs": { } }, "ListResourcesForTagOptionOutput": { "base": null, "refs": { } }, "ListTagOptionsFilters": { "base": "The ListTagOptions filters.
", "refs": { "ListTagOptionsInput$Filters": "The list of filters with which to limit search results. If no search filters are specified, the output is all TagOptions.
" } }, "ListTagOptionsInput": { "base": null, "refs": { } }, "ListTagOptionsOutput": { "base": null, "refs": { } }, "NoEcho": { "base": null, "refs": { "ProvisioningArtifactParameter$IsNoEcho": "If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
" } }, "NotificationArn": { "base": null, "refs": { "NotificationArns$member": null } }, "NotificationArns": { "base": null, "refs": { "ProvisionProductInput$NotificationArns": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
" } }, "OutputKey": { "base": null, "refs": { "RecordOutput$OutputKey": "The output key.
" } }, "OutputValue": { "base": null, "refs": { "RecordOutput$OutputValue": "The output value.
" } }, "PageSize": { "base": null, "refs": { "DescribeRecordInput$PageSize": "The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize
, the value of NextPageToken
in the response is non-null.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListAcceptedPortfolioSharesInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListConstraintsForPortfolioInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListLaunchPathsInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListPortfolioAccessOutput$NextPageToken": "The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListPortfoliosForProductInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListPortfoliosInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListPrincipalsForPortfolioInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListProvisioningArtifactsOutput$NextPageToken": "The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListRecordHistoryInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListResourcesForTagOptionInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "SearchProductsAsAdminInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "SearchProductsInput$PageToken": "The page token of the first page retrieved. If null, this retrieves the first page of size PageSize
.
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" } }, "ParameterConstraints": { "base": "The constraints that the administrator has put on the parameter.
", "refs": { "ProvisioningArtifactParameter$ParameterConstraints": "The list of constraints that the administrator has put on the parameter.
" } }, "ParameterKey": { "base": null, "refs": { "ProvisioningArtifactParameter$ParameterKey": "The parameter key.
", "ProvisioningParameter$Key": "The ProvisioningArtifactParameter.ParameterKey
parameter from DescribeProvisioningParameters.
The ProvisioningArtifactParameter.ParameterKey
parameter from DescribeProvisioningParameters.
The parameter type.
" } }, "ParameterValue": { "base": null, "refs": { "ProvisioningParameter$Value": "The value to use for provisioning. Any constraints on this value can be found in ProvisioningArtifactParameter
for Key
.
The value to use for updating the product provisioning. Any constraints on this value can be found in the ProvisioningArtifactParameter
parameter for Key
.
The text description of the portfolio.
", "PortfolioDetail$Description": "The text description of the portfolio.
", "UpdatePortfolioInput$Description": "The updated text description of the portfolio.
" } }, "PortfolioDetail": { "base": "Detailed portfolio information.
", "refs": { "CreatePortfolioOutput$PortfolioDetail": "The resulting detailed portfolio information.
", "DescribePortfolioOutput$PortfolioDetail": "Detailed portfolio information.
", "PortfolioDetails$member": null, "UpdatePortfolioOutput$PortfolioDetail": "The resulting detailed portfolio information.
" } }, "PortfolioDetails": { "base": null, "refs": { "ListAcceptedPortfolioSharesOutput$PortfolioDetails": "List of detailed portfolio information objects.
", "ListPortfoliosForProductOutput$PortfolioDetails": "List of detailed portfolio information objects.
", "ListPortfoliosOutput$PortfolioDetails": "List of detailed portfolio information objects.
" } }, "PortfolioDisplayName": { "base": null, "refs": { "CreatePortfolioInput$DisplayName": "The name to use for display purposes.
", "PortfolioDetail$DisplayName": "The name to use for display purposes.
", "UpdatePortfolioInput$DisplayName": "The name to use for display purposes.
" } }, "PortfolioName": { "base": null, "refs": { "LaunchPathSummary$Name": "Corresponds to the name of the portfolio to which the user was assigned.
" } }, "Principal": { "base": "A principal's ARN and type.
", "refs": { "Principals$member": null } }, "PrincipalARN": { "base": null, "refs": { "AssociatePrincipalWithPortfolioInput$PrincipalARN": "The ARN representing the principal (IAM user, role, or group).
", "DisassociatePrincipalFromPortfolioInput$PrincipalARN": "The ARN representing the principal (IAM user, role, or group).
", "Principal$PrincipalARN": "The ARN representing the principal (IAM user, role, or group).
" } }, "PrincipalType": { "base": null, "refs": { "AssociatePrincipalWithPortfolioInput$PrincipalType": "The principal type. Must be IAM
The principal type. Must be IAM
The IAM principals (users or roles) associated with the portfolio.
" } }, "ProductArn": { "base": null, "refs": { "CopyProductInput$SourceProductArn": "The Amazon Resource Name (ARN) of the source product.
" } }, "ProductSource": { "base": null, "refs": { "SearchProductsAsAdminInput$ProductSource": "Access level of the source of the product.
" } }, "ProductType": { "base": null, "refs": { "CreateProductInput$ProductType": "The type of the product to create.
", "ProductViewSummary$Type": "The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE
, the product was created by AWS Marketplace.
A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
", "refs": { "ProductViewAggregationValues$member": null } }, "ProductViewAggregationValues": { "base": null, "refs": { "ProductViewAggregations$value": null } }, "ProductViewAggregations": { "base": null, "refs": { "SearchProductsOutput$ProductViewAggregations": "A list of the product view aggregation value objects.
" } }, "ProductViewDetail": { "base": "Detailed product view information.
", "refs": { "CreateProductOutput$ProductViewDetail": "The resulting detailed product view information.
", "DescribeProductAsAdminOutput$ProductViewDetail": "Detailed product view information.
", "ProductViewDetails$member": null, "UpdateProductOutput$ProductViewDetail": "The resulting detailed product view information.
" } }, "ProductViewDetails": { "base": null, "refs": { "SearchProductsAsAdminOutput$ProductViewDetails": "List of detailed product view information objects.
" } }, "ProductViewDistributor": { "base": null, "refs": { "ProductViewSummary$Distributor": "The distributor of the product. Contact the product administrator for the significance of this value.
" } }, "ProductViewFilterBy": { "base": null, "refs": { "ProductViewFilters$key": null } }, "ProductViewFilterValue": { "base": null, "refs": { "ProductViewFilterValues$member": null } }, "ProductViewFilterValues": { "base": null, "refs": { "ProductViewFilters$value": null } }, "ProductViewFilters": { "base": null, "refs": { "SearchProductsAsAdminInput$Filters": "The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.
", "SearchProductsInput$Filters": "The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.
" } }, "ProductViewName": { "base": null, "refs": { "CopyProductInput$TargetProductName": "A name for the target product. The default is the name of the source product.
", "CreateProductInput$Name": "The name of the product.
", "ProductViewSummary$Name": "The name of the product.
", "UpdateProductInput$Name": "The updated product name.
" } }, "ProductViewOwner": { "base": null, "refs": { "CreateProductInput$Owner": "The owner of the product.
", "CreateProductInput$Distributor": "The distributor of the product.
", "ProductViewSummary$Owner": "The owner of the product. Contact the product administrator for the significance of this value.
", "UpdateProductInput$Owner": "The updated owner of the product.
", "UpdateProductInput$Distributor": "The updated distributor of the product.
" } }, "ProductViewShortDescription": { "base": null, "refs": { "CreateProductInput$Description": "The text description of the product.
", "ProductViewSummary$ShortDescription": "Short description of the product.
", "UpdateProductInput$Description": "The updated text description of the product.
" } }, "ProductViewSortBy": { "base": null, "refs": { "SearchProductsAsAdminInput$SortBy": "The sort field specifier. If no value is specified, results are not sorted.
", "SearchProductsInput$SortBy": "The sort field specifier. If no value is specified, results are not sorted.
" } }, "ProductViewSummaries": { "base": null, "refs": { "SearchProductsOutput$ProductViewSummaries": "A list of the product view summary objects.
" } }, "ProductViewSummary": { "base": "The summary metadata about the specified product.
", "refs": { "DescribeProductOutput$ProductViewSummary": "The summary metadata about the specified product.
", "DescribeProductViewOutput$ProductViewSummary": "The summary metadata about the specified product.
", "ProductViewDetail$ProductViewSummary": "The summary metadata about the specified product view.
", "ProductViewSummaries$member": null } }, "ProviderName": { "base": null, "refs": { "CreatePortfolioInput$ProviderName": "The name of the portfolio provider.
", "PortfolioDetail$ProviderName": "The name of the portfolio provider.
", "UpdatePortfolioInput$ProviderName": "The updated name of the portfolio provider.
" } }, "ProvisionProductInput": { "base": null, "refs": { } }, "ProvisionProductOutput": { "base": null, "refs": { } }, "ProvisionedProductDetail": { "base": "Detailed information about a ProvisionedProduct object.
", "refs": { "DescribeProvisionedProductOutput$ProvisionedProductDetail": "Detailed provisioned product information.
", "ProvisionedProductDetails$member": null } }, "ProvisionedProductDetails": { "base": null, "refs": { "ScanProvisionedProductsOutput$ProvisionedProducts": "A list of ProvisionedProduct detail objects.
" } }, "ProvisionedProductId": { "base": null, "refs": { "ProvisionedProductDetail$Id": "The identifier of the ProvisionedProduct object.
" } }, "ProvisionedProductName": { "base": null, "refs": { "ProvisionProductInput$ProvisionedProductName": "A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
", "RecordDetail$ProvisionedProductName": "The user-friendly name of the ProvisionedProduct object.
" } }, "ProvisionedProductNameOrArn": { "base": null, "refs": { "ProvisionedProductDetail$Name": "The user-friendly name of the ProvisionedProduct object.
", "ProvisionedProductDetail$Arn": "The ARN associated with the ProvisionedProduct object.
", "TerminateProvisionedProductInput$ProvisionedProductName": "The name of the ProvisionedProduct object to terminate. Specify either ProvisionedProductName
or ProvisionedProductId
, but not both.
The updated name of the ProvisionedProduct object. Specify either ProvisionedProductName
or ProvisionedProductId
, but not both.
The current status of the ProvisionedProduct.
AVAILABLE
- Stable state, ready to perform any operation. The most recent action request succeeded and completed.
UNDER_CHANGE
- Transitive state, operations performed may or may 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
- Something unexpected happened such that the provisioned product exists but the stack is not running. For example, CloudFormation received an invalid parameter value and could not launch the stack.
The current status message of the ProvisionedProduct.
" } }, "ProvisionedProductType": { "base": null, "refs": { "ProvisionedProductDetail$Type": "The type of the ProvisionedProduct object.
", "RecordDetail$ProvisionedProductType": "The type of the ProvisionedProduct object.
" } }, "ProvisioningArtifact": { "base": "Contains information indicating the ways in which a product can be provisioned.
", "refs": { "ProvisioningArtifacts$member": null } }, "ProvisioningArtifactCreatedTime": { "base": null, "refs": { "ProvisioningArtifact$CreatedTime": "The UTC timestamp of the creation time.
", "ProvisioningArtifactSummary$CreatedTime": "The UTC timestamp of the creation time.
" } }, "ProvisioningArtifactDescription": { "base": null, "refs": { "ProvisioningArtifact$Description": "The text description of the artifact.
", "ProvisioningArtifactProperties$Description": "The text description of the provisioning artifact properties.
", "ProvisioningArtifactSummary$Description": "The description of the provisioning artifact.
", "UpdateProvisioningArtifactInput$Description": "The updated text description of the provisioning artifact.
" } }, "ProvisioningArtifactDetail": { "base": "Detailed provisioning artifact information.
", "refs": { "CreateProductOutput$ProvisioningArtifactDetail": "The resulting detailed provisioning artifact information.
", "CreateProvisioningArtifactOutput$ProvisioningArtifactDetail": "The resulting detailed provisioning artifact information.
", "DescribeProvisioningArtifactOutput$ProvisioningArtifactDetail": "Detailed provisioning artifact information.
", "ProvisioningArtifactDetails$member": null, "UpdateProvisioningArtifactOutput$ProvisioningArtifactDetail": "The resulting detailed provisioning artifact information.
" } }, "ProvisioningArtifactDetails": { "base": null, "refs": { "ListProvisioningArtifactsOutput$ProvisioningArtifactDetails": "List of detailed provisioning artifact information objects.
" } }, "ProvisioningArtifactInfo": { "base": null, "refs": { "CreateProvisioningArtifactOutput$Info": "Additional information about the creation request for the provisioning artifact.
", "DescribeProvisioningArtifactOutput$Info": "Additional information about the provisioning artifact.
", "ProvisioningArtifactProperties$Info": "Additional information about the provisioning artifact properties. When using this element in a request, you must specify LoadTemplateFromURL
. For more information, see CreateProvisioningArtifact.
The provisioning artifact metadata. This data is used with products created by AWS Marketplace.
", "UpdateProvisioningArtifactOutput$Info": "Additional information about the provisioning artifact update request.
" } }, "ProvisioningArtifactInfoKey": { "base": null, "refs": { "ProvisioningArtifactInfo$key": null } }, "ProvisioningArtifactInfoValue": { "base": null, "refs": { "ProvisioningArtifactInfo$value": null } }, "ProvisioningArtifactName": { "base": null, "refs": { "ProvisioningArtifact$Name": "The name of the artifact.
", "ProvisioningArtifactDetail$Name": "The name assigned to the provisioning artifact.
", "ProvisioningArtifactDetail$Description": "The text description of the provisioning artifact.
", "ProvisioningArtifactProperties$Name": "The name assigned to the provisioning artifact properties.
", "ProvisioningArtifactSummary$Name": "The name of the provisioning artifact.
", "UpdateProvisioningArtifactInput$Name": "The updated name of the provisioning artifact.
" } }, "ProvisioningArtifactParameter": { "base": "A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.
", "refs": { "ProvisioningArtifactParameters$member": null } }, "ProvisioningArtifactParameters": { "base": null, "refs": { "DescribeProvisioningParametersOutput$ProvisioningArtifactParameters": "The list of parameters used to successfully provision the product. Each parameter includes a list of allowable values and additional metadata about each parameter.
" } }, "ProvisioningArtifactProperties": { "base": "Provisioning artifact properties. For example request JSON, see CreateProvisioningArtifact.
", "refs": { "CreateProductInput$ProvisioningArtifactParameters": "Parameters for the provisioning artifact.
", "CreateProvisioningArtifactInput$Parameters": "The parameters to use when creating the new provisioning artifact.
" } }, "ProvisioningArtifactPropertyName": { "base": null, "refs": { "SourceProvisioningArtifactPropertiesMap$key": null } }, "ProvisioningArtifactPropertyValue": { "base": null, "refs": { "SourceProvisioningArtifactPropertiesMap$value": null } }, "ProvisioningArtifactSummaries": { "base": null, "refs": { "DescribeProductAsAdminOutput$ProvisioningArtifactSummaries": "A list of provisioning artifact summaries for the product.
" } }, "ProvisioningArtifactSummary": { "base": "Stores summary information about a provisioning artifact.
", "refs": { "ProvisioningArtifactSummaries$member": null } }, "ProvisioningArtifactType": { "base": null, "refs": { "ProvisioningArtifactDetail$Type": "The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI
- AMI products.
MARKETPLACE_CAR
- CAR (Cluster and AWS Resources) products.
The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products:
MARKETPLACE_AMI
- AMI products.
MARKETPLACE_CAR
- CAR (Cluster and AWS Resources) products.
A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts
parameter represent the ways the specified product can be provisioned.
A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts
represent the ways in which the specified product can be provisioned.
The parameter key-value pairs used to provision a product.
", "refs": { "ProvisioningParameters$member": null } }, "ProvisioningParameters": { "base": null, "refs": { "ProvisionProductInput$ProvisioningParameters": "Parameters specified by the administrator that are required for provisioning the product.
" } }, "RecordDetail": { "base": "The full details of a specific ProvisionedProduct object.
", "refs": { "DescribeRecordOutput$RecordDetail": "Detailed record information for the specified product.
", "ProvisionProductOutput$RecordDetail": "The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.
", "RecordDetails$member": null, "TerminateProvisionedProductOutput$RecordDetail": "The detailed result of the TerminateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
", "UpdateProvisionedProductOutput$RecordDetail": "The detailed result of the UpdateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
" } }, "RecordDetails": { "base": null, "refs": { "ListRecordHistoryOutput$RecordDetails": "A list of record detail objects, listed in reverse chronological order.
" } }, "RecordError": { "base": "The error code and description resulting from an operation.
", "refs": { "RecordErrors$member": null } }, "RecordErrors": { "base": null, "refs": { "RecordDetail$RecordErrors": "A list of errors that occurred while processing the request.
" } }, "RecordOutput": { "base": "An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
", "refs": { "RecordOutputs$member": null } }, "RecordOutputs": { "base": null, "refs": { "DescribeRecordOutput$RecordOutputs": "A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
" } }, "RecordStatus": { "base": null, "refs": { "RecordDetail$Status": "The status of the ProvisionedProduct object.
CREATED
- Request created but the operation has not yet 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 completed but has failed. Investigate using the error messages returned.
A tag associated with the record, stored as a key-value pair.
", "refs": { "RecordTags$member": null } }, "RecordTagKey": { "base": null, "refs": { "RecordTag$Key": "The key for this tag.
" } }, "RecordTagValue": { "base": null, "refs": { "RecordTag$Value": "The value for this tag.
" } }, "RecordTags": { "base": null, "refs": { "RecordDetail$RecordTags": "List of tags associated with this record.
" } }, "RecordType": { "base": null, "refs": { "RecordDetail$RecordType": "The record type for this record.
" } }, "RejectPortfolioShareInput": { "base": null, "refs": { } }, "RejectPortfolioShareOutput": { "base": null, "refs": { } }, "ResourceARN": { "base": null, "refs": { "PortfolioDetail$ARN": "The ARN assigned to the portfolio.
", "ProductViewDetail$ProductARN": "The ARN associated with the product.
" } }, "ResourceDetail": { "base": "Detailed resource information.
", "refs": { "ResourceDetails$member": null } }, "ResourceDetailARN": { "base": null, "refs": { "ResourceDetail$ARN": "ARN of the resource.
" } }, "ResourceDetailCreatedTime": { "base": null, "refs": { "ResourceDetail$CreatedTime": "Creation time of the resource.
" } }, "ResourceDetailDescription": { "base": null, "refs": { "ResourceDetail$Description": "Description of the resource.
" } }, "ResourceDetailId": { "base": null, "refs": { "ResourceDetail$Id": "Identifier of the resource.
" } }, "ResourceDetailName": { "base": null, "refs": { "ResourceDetail$Name": "Name of the resource.
" } }, "ResourceDetails": { "base": null, "refs": { "ListResourcesForTagOptionOutput$ResourceDetails": "The resulting detailed resource information.
" } }, "ResourceId": { "base": null, "refs": { "AssociateTagOptionWithResourceInput$ResourceId": "The resource identifier.
", "DisassociateTagOptionFromResourceInput$ResourceId": "Identifier of the resource from which to disassociate the TagOption.
" } }, "ResourceInUseException": { "base": "The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.
", "refs": { } }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "ListResourcesForTagOptionInput$ResourceType": "Resource type.
" } }, "ScanProvisionedProductsInput": { "base": null, "refs": { } }, "ScanProvisionedProductsOutput": { "base": null, "refs": { } }, "SearchFilterKey": { "base": null, "refs": { "ListRecordHistorySearchFilter$Key": "The filter key.
" } }, "SearchFilterValue": { "base": null, "refs": { "ListRecordHistorySearchFilter$Value": "The filter value for Key
.
The sort order specifier. If no value is specified, results are not sorted.
", "SearchProductsInput$SortOrder": "The sort order specifier. If no value is specified, results are not sorted.
" } }, "SourceProvisioningArtifactProperties": { "base": null, "refs": { "CopyProductInput$SourceProvisioningArtifactIdentifiers": "The IDs of the product versions to copy. By default, all provisioning artifacts are copied.
" } }, "SourceProvisioningArtifactPropertiesMap": { "base": null, "refs": { "SourceProvisioningArtifactProperties$member": null } }, "Status": { "base": null, "refs": { "CreateConstraintOutput$Status": "The status of the current request.
", "CreateProvisioningArtifactOutput$Status": "The status of the current request.
", "DescribeConstraintOutput$Status": "The status of the current request.
", "DescribeProvisioningArtifactOutput$Status": "The status of the current request.
", "ProductViewDetail$Status": "Current status of the product.
AVAILABLE
- Product is available for use.
CREATING
- Creation of product started, not ready for use.
FAILED
- Action on product failed.
The status of the current request.
", "UpdateProvisioningArtifactOutput$Status": "The status of the current request.
" } }, "StatusDetail": { "base": null, "refs": { "DescribeCopyProductStatusOutput$StatusDetail": "The status message.
" } }, "SupportDescription": { "base": null, "refs": { "CreateProductInput$SupportDescription": "Support information about the product.
", "ProductViewSummary$SupportDescription": "The description of the support for this Product.
", "UpdateProductInput$SupportDescription": "The updated support description for the product.
" } }, "SupportEmail": { "base": null, "refs": { "CreateProductInput$SupportEmail": "Contact email for product support.
", "ProductViewSummary$SupportEmail": "The email contact information to obtain support for this Product.
", "UpdateProductInput$SupportEmail": "The updated support email for the product.
" } }, "SupportUrl": { "base": null, "refs": { "CreateProductInput$SupportUrl": "Contact URL for product support.
", "ProductViewSummary$SupportUrl": "The URL information to obtain support for this Product.
", "UpdateProductInput$SupportUrl": "The updated support URL for the product.
" } }, "Tag": { "base": "Key-value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
", "refs": { "AddTags$member": null, "Tags$member": null } }, "TagKey": { "base": null, "refs": { "Tag$Key": "The ProvisioningArtifactParameter.TagKey
parameter from DescribeProvisioningParameters.
Tags to remove from the existing list of tags associated with the portfolio.
", "UpdateProductInput$RemoveTags": "Tags to remove from the existing list of tags associated with the product.
" } }, "TagOptionActive": { "base": null, "refs": { "ListTagOptionsFilters$Active": "The ListTagOptionsFilters active state.
", "TagOptionDetail$Active": "The TagOptionDetail active state.
", "UpdateTagOptionInput$Active": "The updated active state.
" } }, "TagOptionDetail": { "base": "The TagOption details.
", "refs": { "CreateTagOptionOutput$TagOptionDetail": "The resulting detailed TagOption information.
", "DescribeTagOptionOutput$TagOptionDetail": "The resulting detailed TagOption information.
", "TagOptionDetails$member": null, "UpdateTagOptionOutput$TagOptionDetail": "The resulting detailed TagOption information.
" } }, "TagOptionDetails": { "base": null, "refs": { "DescribePortfolioOutput$TagOptions": "TagOptions associated with the portfolio.
", "DescribeProductAsAdminOutput$TagOptions": "List of TagOptions associated with the product.
", "ListTagOptionsOutput$TagOptionDetails": "The resulting detailed TagOption information.
" } }, "TagOptionId": { "base": null, "refs": { "AssociateTagOptionWithResourceInput$TagOptionId": "The TagOption identifier.
", "DescribeTagOptionInput$Id": "The identifier of the TagOption.
", "DisassociateTagOptionFromResourceInput$TagOptionId": "Identifier of the TagOption to disassociate from the resource.
", "ListResourcesForTagOptionInput$TagOptionId": "Identifier of the TagOption.
", "TagOptionDetail$Id": "The TagOptionDetail identifier.
", "UpdateTagOptionInput$Id": "The identifier of the constraint to update.
" } }, "TagOptionKey": { "base": null, "refs": { "CreateTagOptionInput$Key": "The TagOption key.
", "ListTagOptionsFilters$Key": "The ListTagOptionsFilters key.
", "TagOptionDetail$Key": "The TagOptionDetail key.
", "TagOptionSummary$Key": "The TagOptionSummary key.
" } }, "TagOptionNotMigratedException": { "base": "An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Please use the AWS console to perform the migration process before retrying the operation.
", "refs": { } }, "TagOptionSummaries": { "base": null, "refs": { "DescribeProvisioningParametersOutput$TagOptions": "List of TagOptions associated with the provisioned provisioning parameters.
" } }, "TagOptionSummary": { "base": "The TagOption summary key-value pair.
", "refs": { "TagOptionSummaries$member": null } }, "TagOptionValue": { "base": null, "refs": { "CreateTagOptionInput$Value": "The TagOption value.
", "ListTagOptionsFilters$Value": "The ListTagOptionsFilters value.
", "TagOptionDetail$Value": "The TagOptionDetail value.
", "TagOptionValues$member": null, "UpdateTagOptionInput$Value": "The updated value.
" } }, "TagOptionValues": { "base": null, "refs": { "TagOptionSummary$Values": "The TagOptionSummary value.
" } }, "TagValue": { "base": null, "refs": { "Tag$Value": "The desired value for this key.
" } }, "Tags": { "base": null, "refs": { "CreatePortfolioOutput$Tags": "Tags successfully associated with the new portfolio.
", "CreateProductOutput$Tags": "Tags successfully associated with the new product.
", "DescribePortfolioOutput$Tags": "Tags associated with the portfolio.
", "DescribeProductAsAdminOutput$Tags": "Tags associated with the product.
", "LaunchPathSummary$Tags": "List of tags used by this launch path.
", "ProvisionProductInput$Tags": "A list of tags to use as provisioning options.
", "UpdatePortfolioOutput$Tags": "Tags associated with the portfolio.
", "UpdateProductOutput$Tags": "Tags associated with the product.
" } }, "TerminateProvisionedProductInput": { "base": null, "refs": { } }, "TerminateProvisionedProductOutput": { "base": null, "refs": { } }, "UpdateConstraintInput": { "base": null, "refs": { } }, "UpdateConstraintOutput": { "base": null, "refs": { } }, "UpdatePortfolioInput": { "base": null, "refs": { } }, "UpdatePortfolioOutput": { "base": null, "refs": { } }, "UpdateProductInput": { "base": null, "refs": { } }, "UpdateProductOutput": { "base": null, "refs": { } }, "UpdateProvisionedProductInput": { "base": null, "refs": { } }, "UpdateProvisionedProductOutput": { "base": null, "refs": { } }, "UpdateProvisioningArtifactInput": { "base": null, "refs": { } }, "UpdateProvisioningArtifactOutput": { "base": null, "refs": { } }, "UpdateProvisioningParameter": { "base": "The parameter key-value pair used to update a ProvisionedProduct object. If UsePreviousValue
is set to true, Value
is ignored and the value for Key
is kept as previously set (current value).
A list of ProvisioningParameter
objects used to update the ProvisionedProduct object.
The time when the record for the ProvisionedProduct object was last updated.
" } }, "UsageInstruction": { "base": "Additional information provided by the administrator.
", "refs": { "UsageInstructions$member": null } }, "UsageInstructions": { "base": null, "refs": { "DescribeProvisioningParametersOutput$UsageInstructions": "Any additional metadata specifically related to the provisioning of the product. For example, see the Version
field of the CloudFormation template.
If true, uses the currently set value for Key
, ignoring UpdateProvisioningParameter.Value
.
Enable a verbose level of details for the provisioning artifact.
" } } } }