View Source aws_service_catalog (aws v1.0.4)
Service Catalog
Service Catalog: http://aws.amazon.com/servicecatalog 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: http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html.Summary
Functions
Associates the specified principal ARN with the specified portfolio.
Associates the specified product with the specified portfolio.
Copies the specified source product to the specified target product or a new product.
Creates a constraint.
Creates a portfolio.
Shares the specified portfolio with the specified account or organization node.
Creates a product.
Creates a plan.
Creates a provisioning artifact (also known as a version) for the specified product.
Deletes the specified constraint.
Deletes the specified portfolio.
Stops sharing the specified portfolio with the specified account or organization node.
Deletes the specified product.
Deletes the specified provisioning artifact (also known as a version) for the specified product.
Deletes the specified TagOption.
Gets information about the specified portfolio.
Gets the status of the specified portfolio share operation.
Returns a summary of each of the portfolio shares that were created for the specified portfolio.
Gets information about the specified product.
Gets information about the specified product.
Gets information about the configuration required to provision the specified product using the specified provisioning artifact.
Gets information about the specified request operation.
Disable portfolio sharing through the Organizations service.
Disassociates a previously associated principal ARN from a specified portfolio.
Disassociates the specified product from the specified portfolio.
Enable portfolio sharing feature through Organizations.
Get the Access Status for Organizations portfolio share feature.
ProvisonedProductId
or a ProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.
Lists all imported portfolios for which account-to-account shares were accepted by this account.
Lists the paths to the specified product.
Lists the organization nodes that have access to the specified portfolio.
Lists the account IDs that have access to the specified portfolio.
PrincipalARN
s and corresponding PrincipalType
s associated with the specified portfolio.Returns summary information about stack instances that are associated with the specified CFN_STACKSET
type provisioned product.
Provisions the specified product.
Lists the provisioned products that are available (not terminated).
Terminates the specified provisioned product.
Updates the specified portfolio.
Updates the specified portfolio share.
Requests updates to the configuration of the specified provisioned product.
Updates the specified provisioning artifact (also known as a version) for the specified product.
Functions
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
.
PrincipalType
as IAM
. With this configuration, the PrincipalARN
must already exist in the recipient account before it can be associated.
Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.associate_service_action_with_provisioning_artifact(Client, Input)
View Sourceassociate_service_action_with_provisioning_artifact(Client, Input, Options)
View Sourcebatch_associate_service_action_with_provisioning_artifact(Client, Input)
View Sourcebatch_associate_service_action_with_provisioning_artifact(Client, Input, Options)
View Sourcebatch_disassociate_service_action_from_provisioning_artifact(Client, Input)
View Sourcebatch_disassociate_service_action_from_provisioning_artifact(Client, Input, Options)
View SourceCopies 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
.
DescribeCopyProductStatus
.
Creates a constraint.
A delegated admin is authorized to invoke this command.Creates a portfolio.
A delegated admin is authorized to invoke this command.Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have thecloudformation:GetTemplate
IAM policy permission. This policy permission is required when using the ImportFromPhysicalId
template source in the information data section.
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, useDescribeProvisionedProductPlan
. To create or modify the provisioned product, use ExecuteProvisionedProductPlan
.
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 thecloudformation:GetTemplate
IAM policy permission. This policy permission is required when using the ImportFromPhysicalId
template source in the information data section.
Deletes the specified constraint.
A delegated admin is authorized to invoke this command.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.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.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.Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.Gets information about the specified product.
Running this operation with administrator access results in a failure.DescribeProductAsAdmin
should be used instead.
Gets information about the specified product.
This operation is run with administrator access.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 toProvisionProduct
, 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
.
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct
, TerminateProvisionedProduct
, or UpdateProvisionedProduct
).
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.
describe_service_action_execution_parameters(Client, Input, Options)
View SourceDisable 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
.
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: https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options in the Amazon Web Services CLI Command Reference.
If you disassociate a principal from a portfolio, with PrincipalType asIAM
, 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.
Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.disassociate_service_action_from_provisioning_artifact(Client, Input)
View Sourcedisassociate_service_action_from_provisioning_artifact(Client, Input, Options)
View SourceEnable 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
.
execute_provisioned_product_service_action(Client, Input, Options)
View SourceGet 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.ProvisonedProductId
or a ProvisionedProductName
, along with a list of one or more output keys, and responds with the key/value pairs of those outputs.
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.
IMPORT_COMPLETE
status before you import another.
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: https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html in the Service Catalog User Guide.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.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.PrincipalARN
s and corresponding PrincipalType
s associated with the specified portfolio.
list_provisioning_artifacts_for_service_action(Client, Input, Options)
View Sourcelist_service_actions_for_provisioning_artifact(Client, Input, Options)
View SourceReturns summary information about stack instances that are associated with the specified CFN_STACKSET
type provisioned product.
list_stack_instances_for_provisioned_product(Client, Input, Options)
View Sourcenotify_provision_product_engine_workflow_result(Client, Input, Options)
View Sourcenotify_terminate_provisioned_product_engine_workflow_result(Client, Input)
View Sourcenotify_terminate_provisioned_product_engine_workflow_result(Client, Input, Options)
View Sourcenotify_update_provisioned_product_engine_workflow_result(Client, Input)
View Sourcenotify_update_provisioned_product_engine_workflow_result(Client, Input, Options)
View SourceProvisions 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: https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html in the Service Catalog User Guide.Lists the provisioned products that are available (not terminated).
To use additional filtering, seeSearchProvisionedProducts
.
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 usingDescribeRecord
.
Updates the specified portfolio.
You cannot update a product that was shared with you.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 usingDescribeRecord
.
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.