Table of Contents
ServiceCatalog.Client¶A low-level client representing AWS 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 .
import boto3
client = boto3.client('servicecatalog')
These are the available methods:
accept_portfolio_share()associate_budget_with_resource()associate_principal_with_portfolio()associate_product_with_portfolio()associate_service_action_with_provisioning_artifact()associate_tag_option_with_resource()batch_associate_service_action_with_provisioning_artifact()batch_disassociate_service_action_from_provisioning_artifact()can_paginate()close()copy_product()create_constraint()create_portfolio()create_portfolio_share()create_product()create_provisioned_product_plan()create_provisioning_artifact()create_service_action()create_tag_option()delete_constraint()delete_portfolio()delete_portfolio_share()delete_product()delete_provisioned_product_plan()delete_provisioning_artifact()delete_service_action()delete_tag_option()describe_constraint()describe_copy_product_status()describe_portfolio()describe_portfolio_share_status()describe_portfolio_shares()describe_product()describe_product_as_admin()describe_product_view()describe_provisioned_product()describe_provisioned_product_plan()describe_provisioning_artifact()describe_provisioning_parameters()describe_record()describe_service_action()describe_service_action_execution_parameters()describe_tag_option()disable_aws_organizations_access()disassociate_budget_from_resource()disassociate_principal_from_portfolio()disassociate_product_from_portfolio()disassociate_service_action_from_provisioning_artifact()disassociate_tag_option_from_resource()enable_aws_organizations_access()execute_provisioned_product_plan()execute_provisioned_product_service_action()get_aws_organizations_access_status()get_paginator()get_provisioned_product_outputs()get_waiter()import_as_provisioned_product()list_accepted_portfolio_shares()list_budgets_for_resource()list_constraints_for_portfolio()list_launch_paths()list_organization_portfolio_access()list_portfolio_access()list_portfolios()list_portfolios_for_product()list_principals_for_portfolio()list_provisioned_product_plans()list_provisioning_artifacts()list_provisioning_artifacts_for_service_action()list_record_history()list_resources_for_tag_option()list_service_actions()list_service_actions_for_provisioning_artifact()list_stack_instances_for_provisioned_product()list_tag_options()provision_product()reject_portfolio_share()scan_provisioned_products()search_products()search_products_as_admin()search_provisioned_products()terminate_provisioned_product()update_constraint()update_portfolio()update_portfolio_share()update_product()update_provisioned_product()update_provisioned_product_properties()update_provisioning_artifact()update_service_action()update_tag_option()Accepts an offer to share the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.accept_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
PortfolioShareType='IMPORTED'|'AWS_SERVICECATALOG'|'AWS_ORGANIZATIONS'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
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
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionassociate_budget_with_resource(**kwargs)¶Associates the specified budget with the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.associate_budget_with_resource(
BudgetName='string',
ResourceId='string'
)
[REQUIRED]
The name of the budget you want to associate.
[REQUIRED]
The resource identifier. Either a portfolio-id or a product-id.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionassociate_principal_with_portfolio(**kwargs)¶Associates the specified principal ARN with the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.associate_principal_with_portfolio(
AcceptLanguage='string',
PortfolioId='string',
PrincipalARN='string',
PrincipalType='IAM'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
[REQUIRED]
The ARN of the principal (IAM user, role, or group).
[REQUIRED]
The principal type. The supported value is IAM .
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionassociate_product_with_portfolio(**kwargs)¶Associates the specified product with the specified portfolio.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.associate_product_with_portfolio(
AcceptLanguage='string',
ProductId='string',
PortfolioId='string',
SourcePortfolioId='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionassociate_service_action_with_provisioning_artifact(**kwargs)¶Associates a self-service action with a provisioning artifact.
See also: AWS API Documentation
Request Syntax
response = client.associate_service_action_with_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
ServiceActionId='string',
AcceptLanguage='string'
)
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionassociate_tag_option_with_resource(**kwargs)¶Associate the specified TagOption with the specified portfolio or product.
See also: AWS API Documentation
Request Syntax
response = client.associate_tag_option_with_resource(
ResourceId='string',
TagOptionId='string'
)
[REQUIRED]
The resource identifier.
[REQUIRED]
The TagOption identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionbatch_associate_service_action_with_provisioning_artifact(**kwargs)¶Associates multiple self-service actions with provisioning artifacts.
See also: AWS API Documentation
Request Syntax
response = client.batch_associate_service_action_with_provisioning_artifact(
ServiceActionAssociations=[
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
],
AcceptLanguage='string'
)
[REQUIRED]
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
The self-service action identifier. For example, act-fs7abcd89wxyz .
The product identifier. For example, prod-abcdzk7xy33qa .
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'FailedServiceActionAssociations': [
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedServiceActionAssociations (list) --
An object that contains a list of errors, along with information to help you identify the self-service action.
(dict) --
An object containing information about the error, along with identifying information about the self-service action and its associations.
ServiceActionId (string) --
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
ErrorCode (string) --
The error code. Valid values are listed below.
ErrorMessage (string) --
A text description of the error.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionbatch_disassociate_service_action_from_provisioning_artifact(**kwargs)¶Disassociates a batch of self-service actions from the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
response = client.batch_disassociate_service_action_from_provisioning_artifact(
ServiceActionAssociations=[
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string'
},
],
AcceptLanguage='string'
)
[REQUIRED]
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
The self-service action identifier. For example, act-fs7abcd89wxyz .
The product identifier. For example, prod-abcdzk7xy33qa .
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'FailedServiceActionAssociations': [
{
'ServiceActionId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedServiceActionAssociations (list) --
An object that contains a list of errors, along with information to help you identify the self-service action.
(dict) --
An object containing information about the error, along with identifying information about the self-service action and its associations.
ServiceActionId (string) --
The self-service action identifier. For example, act-fs7abcd89wxyz .
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
ErrorCode (string) --
The error code. Valid values are listed below.
ErrorMessage (string) --
A text description of the error.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_product(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.copy_product(
AcceptLanguage='string',
SourceProductArn='string',
TargetProductId='string',
TargetProductName='string',
SourceProvisioningArtifactIdentifiers=[
{
'string': 'string'
},
],
CopyOptions=[
'CopyTags',
],
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The Amazon Resource Name (ARN) of the source product.
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.
The copy options. If the value is CopyTags , the tags from the source product are copied to the target product.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'CopyProductToken': 'string'
}
Response Structure
(dict) --
CopyProductToken (string) --
The token to use to track the progress of the operation.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptioncreate_constraint(**kwargs)¶Creates a constraint.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.create_constraint(
AcceptLanguage='string',
PortfolioId='string',
ProductId='string',
Parameters='string',
Type='string',
Description='string',
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
[REQUIRED]
The product identifier.
[REQUIRED]
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.
Note
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 .
[REQUIRED]
The type of constraint.
LAUNCHNOTIFICATIONRESOURCE_UPDATESTACKSETTEMPLATE[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string',
'ProductId': 'string',
'PortfolioId': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ConstraintDetail (dict) --
Information about the constraint.
ConstraintId (string) --
The identifier of the constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Owner (string) --
The owner of the constraint.
ProductId (string) --
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
PortfolioId (string) --
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
ConstraintParameters (string) --
The constraint parameters.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptioncreate_portfolio(**kwargs)¶Creates a portfolio.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.create_portfolio(
AcceptLanguage='string',
DisplayName='string',
Description='string',
ProviderName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The name to use for display purposes.
[REQUIRED]
The name of the portfolio provider.
One or more tags.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'PortfolioDetail': {
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
PortfolioDetail (dict) --
Information about the portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
Tags (list) --
Information about the tags associated with the portfolio.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionShares 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.
AWSOrganizationsAccessmust 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.
See also: AWS API Documentation
Request Syntax
response = client.create_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string',
OrganizationNode={
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
},
ShareTagOptions=True|False
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
123456789012 .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.
The organization node type.
The identifier of the organization node.
TagOptions sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.dict
Response Syntax
{
'PortfolioShareToken': 'string'
}
Response Structure
(dict) --
PortfolioShareToken (string) --
The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionServiceCatalog.Client.exceptions.InvalidStateExceptioncreate_product(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_product(
AcceptLanguage='string',
Name='string',
Owner='string',
Description='string',
Distributor='string',
SupportDescription='string',
SupportEmail='string',
SupportUrl='string',
ProductType='CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ProvisioningArtifactParameters={
'Name': 'string',
'Description': 'string',
'Info': {
'string': 'string'
},
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'DisableTemplateValidation': True|False
},
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The name of the product.
[REQUIRED]
The owner of the product.
The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.
[REQUIRED]
The type of product.
One or more tags.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
[REQUIRED]
The configuration of the provisioning artifact.
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
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, Amazon Web Services CodeCommit, 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]
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesIf set to true, Amazon Web Services Service Catalog stops validating the specified provisioning artifact even if it is invalid.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
The status of the product.
AVAILABLE - The product is ready for use.CREATING - Product creation has started; the product is not ready for use.FAILED - An action failed.ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesCreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Tags (list) --
Information about the tags associated with the product.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptioncreate_provisioned_product_plan(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.create_provisioned_product_plan(
AcceptLanguage='string',
PlanName='string',
PlanType='CLOUDFORMATION',
NotificationArns=[
'string',
],
PathId='string',
ProductId='string',
ProvisionedProductName='string',
ProvisioningArtifactId='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The name of the plan.
[REQUIRED]
The plan type.
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
[REQUIRED]
The product identifier.
[REQUIRED]
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.
[REQUIRED]
The identifier of the provisioning artifact.
Parameters specified by the administrator that are required for provisioning the product.
The parameter key-value pair used to update a provisioned product.
The parameter key.
The parameter value.
If set to true, Value is ignored and the previous parameter value is kept.
[REQUIRED]
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.
This field is autopopulated if not provided.
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.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
dict
Response Syntax
{
'PlanName': 'string',
'PlanId': 'string',
'ProvisionProductId': 'string',
'ProvisionedProductName': 'string',
'ProvisioningArtifactId': 'string'
}
Response Structure
(dict) --
PlanName (string) --
The name of the plan.
PlanId (string) --
The plan identifier.
ProvisionProductId (string) --
The product identifier.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptioncreate_provisioning_artifact(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
Parameters={
'Name': 'string',
'Description': 'string',
'Info': {
'string': 'string'
},
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'DisableTemplateValidation': True|False
},
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The configuration for the provisioning artifact.
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
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, Amazon Web Services CodeCommit, 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]
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesIf set to true, Amazon Web Services Service Catalog stops validating the specified provisioning artifact even if it is invalid.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesCreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Info (dict) --
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, Amazon Web Services CodeCommit, or GitHub in JSON format.
LoadTemplateFromURL
Use the URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.
ImportFromPhysicalId
Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptioncreate_service_action(**kwargs)¶Creates a self-service action.
See also: AWS API Documentation
Request Syntax
response = client.create_service_action(
Name='string',
DefinitionType='SSM_AUTOMATION',
Definition={
'string': 'string'
},
Description='string',
AcceptLanguage='string',
IdempotencyToken='string'
)
[REQUIRED]
The self-service action name.
[REQUIRED]
The service action definition type. For example, SSM_AUTOMATION .
[REQUIRED]
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\"}] .
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
An object containing information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.LimitExceededExceptioncreate_tag_option(**kwargs)¶Creates a TagOption.
See also: AWS API Documentation
Request Syntax
response = client.create_tag_option(
Key='string',
Value='string'
)
[REQUIRED]
The TagOption key.
[REQUIRED]
The TagOption value.
dict
Response Syntax
{
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
}
}
Response Structure
(dict) --
TagOptionDetail (dict) --
Information about the TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.LimitExceededExceptiondelete_constraint(**kwargs)¶Deletes the specified constraint.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.delete_constraint(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The identifier of the constraint.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondelete_portfolio(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_portfolio(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionStops 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.
See also: AWS API Documentation
Request Syntax
response = client.delete_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string',
OrganizationNode={
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
The organization node to whom you are going to stop sharing.
The organization node type.
The identifier of the organization node.
dict
Response Syntax
{
'PortfolioShareToken': 'string'
}
Response Structure
(dict) --
PortfolioShareToken (string) --
The portfolio share unique identifier. This will only be returned if delete is made to an organization node.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionServiceCatalog.Client.exceptions.InvalidStateExceptiondelete_product(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_product(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptiondelete_provisioned_product_plan(**kwargs)¶Deletes the specified plan.
See also: AWS API Documentation
Request Syntax
response = client.delete_provisioned_product_plan(
AcceptLanguage='string',
PlanId='string',
IgnoreErrors=True|False
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The plan identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondelete_provisioning_artifact(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The identifier of the provisioning artifact.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondelete_service_action(**kwargs)¶Deletes a self-service action.
See also: AWS API Documentation
Request Syntax
response = client.delete_service_action(
Id='string',
AcceptLanguage='string'
)
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptiondelete_tag_option(**kwargs)¶Deletes the specified TagOption.
You cannot delete a TagOption if it is associated with a product or portfolio.
See also: AWS API Documentation
Request Syntax
response = client.delete_tag_option(
Id='string'
)
[REQUIRED]
The TagOption identifier.
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_constraint(**kwargs)¶Gets information about the specified constraint.
See also: AWS API Documentation
Request Syntax
response = client.describe_constraint(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The identifier of the constraint.
dict
Response Syntax
{
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string',
'ProductId': 'string',
'PortfolioId': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ConstraintDetail (dict) --
Information about the constraint.
ConstraintId (string) --
The identifier of the constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Owner (string) --
The owner of the constraint.
ProductId (string) --
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
PortfolioId (string) --
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
ConstraintParameters (string) --
The constraint parameters.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_copy_product_status(**kwargs)¶Gets the status of the specified copy product operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_copy_product_status(
AcceptLanguage='string',
CopyProductToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The token for the copy product operation. This token is returned by CopyProduct .
dict
Response Syntax
{
'CopyProductStatus': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
'TargetProductId': 'string',
'StatusDetail': 'string'
}
Response Structure
(dict) --
CopyProductStatus (string) --
The status of the copy product operation.
TargetProductId (string) --
The identifier of the copied product.
StatusDetail (string) --
The status message.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_portfolio(**kwargs)¶Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.describe_portfolio(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{
'PortfolioDetail': {
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'TagOptions': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
},
],
'Budgets': [
{
'BudgetName': 'string'
},
]
}
Response Structure
(dict) --
PortfolioDetail (dict) --
Information about the portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
Tags (list) --
Information about the tags associated with the portfolio.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
TagOptions (list) --
Information about the TagOptions associated with the portfolio.
(dict) --
Information about a TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionGets 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_portfolio_share_status(
PortfolioShareToken='string'
)
[REQUIRED]
The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.
{
'PortfolioShareToken': 'string',
'PortfolioId': 'string',
'OrganizationNodeValue': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'ERROR',
'ShareDetails': {
'SuccessfulShares': [
'string',
],
'ShareErrors': [
{
'Accounts': [
'string',
],
'Message': 'string',
'Error': 'string'
},
]
}
}
Response Structure
The token for the portfolio share operation. For example, share-6v24abcdefghi .
The portfolio identifier.
Organization node identifier. It can be either account id, organizational unit id or organization id.
Status of the portfolio share operation.
Information about the portfolio share operation.
List of accounts for whom the operation succeeded.
List of errors.
Errors that occurred during the portfolio share operation.
List of accounts impacted by the error.
Information about the error.
Error type that happened when processing the operation.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionReturns 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_portfolio_shares(
PortfolioId='string',
Type='ACCOUNT'|'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ORGANIZATION_MEMBER_ACCOUNT',
PageToken='string',
PageSize=123
)
[REQUIRED]
The unique identifier of the portfolio for which shares will be retrieved.
[REQUIRED]
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:
ACCOUNT - Represents an external account to account share.ORGANIZATION - Represents a share to an organization. This share is available to every account in the organization.ORGANIZATIONAL_UNIT - Represents a share to an organizational unit.ORGANIZATION_MEMBER_ACCOUNT - Represents a share to an account in the organization.dict
Response Syntax
{
'NextPageToken': 'string',
'PortfolioShareDetails': [
{
'PrincipalId': 'string',
'Type': 'ACCOUNT'|'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ORGANIZATION_MEMBER_ACCOUNT',
'Accepted': True|False,
'ShareTagOptions': True|False
},
]
}
Response Structure
(dict) --
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
PortfolioShareDetails (list) --
Summaries about each of the portfolio shares.
(dict) --
Information about the portfolio share.
PrincipalId (string) --
The identifier of the recipient entity that received the portfolio share. The recipient entities can be one of the following:
Type (string) --
The type of the portfolio share.
Accepted (boolean) --
Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.
ShareTagOptions (boolean) --
Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_product(**kwargs)¶Gets information about the specified product.
See also: AWS API Documentation
Request Syntax
response = client.describe_product(
AcceptLanguage='string',
Id='string',
Name='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
},
],
'Budgets': [
{
'BudgetName': 'string'
},
],
'LaunchPaths': [
{
'Id': 'string',
'Name': 'string'
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifacts (list) --
Information about the provisioning artifacts for the specified product.
(dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
LaunchPaths (list) --
Information about the associated launch paths.
(dict) --
A launch path object.
Id (string) --
The identifier of the launch path.
Name (string) --
The name of the launch path.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_product_as_admin(**kwargs)¶Gets information about the specified product. This operation is run with administrator access.
See also: AWS API Documentation
Request Syntax
response = client.describe_product_as_admin(
AcceptLanguage='string',
Id='string',
Name='string',
SourcePortfolioId='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe 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.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'ProvisioningArtifactSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProvisioningArtifactMetadata': {
'string': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'TagOptions': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
},
],
'Budgets': [
{
'BudgetName': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
The status of the product.
AVAILABLE - The product is ready for use.CREATING - Product creation has started; the product is not ready for use.FAILED - An action failed.ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProvisioningArtifactSummaries (list) --
Information about the provisioning artifacts (also known as versions) for the specified product.
(dict) --
Summary information about a provisioning artifact (also known as a version) for a product.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProvisioningArtifactMetadata (dict) --
The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.
Tags (list) --
Information about the tags associated with the product.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
TagOptions (list) --
Information about the TagOptions associated with the product.
(dict) --
Information about a TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_product_view(**kwargs)¶Gets information about the specified product.
See also: AWS API Documentation
Request Syntax
response = client.describe_product_view(
AcceptLanguage='string',
Id='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product view identifier.
dict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
Summary information about the product.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifacts (list) --
Information about the provisioning artifacts for the product.
(dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_provisioned_product(**kwargs)¶Gets information about the specified provisioned product.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioned_product(
AcceptLanguage='string',
Id='string',
Name='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe 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.
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.
dict
Response Syntax
{
'ProvisionedProductDetail': {
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'LaunchRoleArn': 'string'
},
'CloudWatchDashboards': [
{
'Name': 'string'
},
]
}
Response Structure
(dict) --
ProvisionedProductDetail (dict) --
Information about the provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for 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 (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
CloudWatchDashboards (list) --
Any CloudWatch dashboards that were created when provisioning the product.
(dict) --
Information about a CloudWatch dashboard.
Name (string) --
The name of the CloudWatch dashboard.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_provisioned_product_plan(**kwargs)¶Gets information about the resource changes for the specified plan.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioned_product_plan(
AcceptLanguage='string',
PlanId='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The plan identifier.
dict
Response Syntax
{
'ProvisionedProductPlanDetails': {
'CreatedTime': datetime(2015, 1, 1),
'PathId': 'string',
'ProductId': 'string',
'PlanName': 'string',
'PlanId': 'string',
'ProvisionProductId': 'string',
'ProvisionProductName': 'string',
'PlanType': 'CLOUDFORMATION',
'ProvisioningArtifactId': 'string',
'Status': 'CREATE_IN_PROGRESS'|'CREATE_SUCCESS'|'CREATE_FAILED'|'EXECUTE_IN_PROGRESS'|'EXECUTE_SUCCESS'|'EXECUTE_FAILED',
'UpdatedTime': datetime(2015, 1, 1),
'NotificationArns': [
'string',
],
'ProvisioningParameters': [
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'StatusMessage': 'string'
},
'ResourceChanges': [
{
'Action': 'ADD'|'MODIFY'|'REMOVE',
'LogicalResourceId': 'string',
'PhysicalResourceId': 'string',
'ResourceType': 'string',
'Replacement': 'TRUE'|'FALSE'|'CONDITIONAL',
'Scope': [
'PROPERTIES'|'METADATA'|'CREATIONPOLICY'|'UPDATEPOLICY'|'DELETIONPOLICY'|'TAGS',
],
'Details': [
{
'Target': {
'Attribute': 'PROPERTIES'|'METADATA'|'CREATIONPOLICY'|'UPDATEPOLICY'|'DELETIONPOLICY'|'TAGS',
'Name': 'string',
'RequiresRecreation': 'NEVER'|'CONDITIONALLY'|'ALWAYS'
},
'Evaluation': 'STATIC'|'DYNAMIC',
'CausingEntity': 'string'
},
]
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProductPlanDetails (dict) --
Information about the plan.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
PathId (string) --
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .
ProductId (string) --
The product identifier.
PlanName (string) --
The name of the plan.
PlanId (string) --
The plan identifier.
ProvisionProductId (string) --
The product identifier.
ProvisionProductName (string) --
The user-friendly name of the provisioned product.
PlanType (string) --
The plan type.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
Status (string) --
The status.
UpdatedTime (datetime) --
The time when the plan was last updated.
NotificationArns (list) --
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
ProvisioningParameters (list) --
Parameters specified by the administrator that are required for provisioning the product.
(dict) --
The parameter key-value pair used to update a provisioned product.
Key (string) --
The parameter key.
Value (string) --
The parameter value.
UsePreviousValue (boolean) --
If set to true, Value is ignored and the previous parameter value is kept.
Tags (list) --
One or more tags.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
StatusMessage (string) --
The status message.
ResourceChanges (list) --
Information about the resource changes that will occur when the plan is executed.
(dict) --
Information about a resource change that will occur when a plan is executed.
Action (string) --
The change action.
LogicalResourceId (string) --
The ID of the resource, as defined in the CloudFormation template.
PhysicalResourceId (string) --
The ID of the resource, if it was already created.
ResourceType (string) --
The type of resource.
Replacement (string) --
If the change type is Modify , indicates whether the existing resource is deleted and replaced with a new one.
Scope (list) --
The change scope.
Details (list) --
Information about the resource changes.
(dict) --
Information about a change to a resource attribute.
Target (dict) --
Information about the resource attribute to be modified.
Attribute (string) --
The attribute to be changed.
Name (string) --
If the attribute is Properties , the value is the name of the property. Otherwise, the value is null.
RequiresRecreation (string) --
If the attribute is Properties , indicates whether a change to this property causes the resource to be re-created.
Evaluation (string) --
For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.
CausingEntity (string) --
The ID of the entity that caused the change.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_provisioning_artifact(**kwargs)¶Gets information about the specified provisioning artifact (also known as a version) for the specified product.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioning_artifact(
AcceptLanguage='string',
ProvisioningArtifactId='string',
ProductId='string',
ProvisioningArtifactName='string',
ProductName='string',
Verbose=True|False
)
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesCreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Info (dict) --
The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondescribe_provisioning_parameters(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioning_parameters(
AcceptLanguage='string',
ProductId='string',
ProductName='string',
ProvisioningArtifactId='string',
ProvisioningArtifactName='string',
PathId='string',
PathName='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ProvisioningArtifactParameters': [
{
'ParameterKey': 'string',
'DefaultValue': 'string',
'ParameterType': 'string',
'IsNoEcho': True|False,
'Description': 'string',
'ParameterConstraints': {
'AllowedValues': [
'string',
],
'AllowedPattern': 'string',
'ConstraintDescription': 'string',
'MaxLength': 'string',
'MinLength': 'string',
'MaxValue': 'string',
'MinValue': 'string'
}
},
],
'ConstraintSummaries': [
{
'Type': 'string',
'Description': 'string'
},
],
'UsageInstructions': [
{
'Type': 'string',
'Value': 'string'
},
],
'TagOptions': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'ProvisioningArtifactPreferences': {
'StackSetAccounts': [
'string',
],
'StackSetRegions': [
'string',
]
},
'ProvisioningArtifactOutputs': [
{
'Key': 'string',
'Description': 'string'
},
],
'ProvisioningArtifactOutputKeys': [
{
'Key': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
ProvisioningArtifactParameters (list) --
Information about the parameters used to provision the product.
(dict) --
Information about a parameter used to provision a product.
ParameterKey (string) --
The parameter key.
DefaultValue (string) --
The default value.
ParameterType (string) --
The parameter type.
IsNoEcho (boolean) --
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
Description (string) --
The description of the parameter.
ParameterConstraints (dict) --
Constraints that the administrator has put on a parameter.
AllowedValues (list) --
The values that the administrator has allowed for the parameter.
AllowedPattern (string) --
A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.
ConstraintDescription (string) --
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
MaxLength (string) --
An integer value that determines the largest number of characters you want to allow for String types.
MinLength (string) --
An integer value that determines the smallest number of characters you want to allow for String types.
MaxValue (string) --
A numeric value that determines the largest numeric value you want to allow for Number types.
MinValue (string) --
A numeric value that determines the smallest numeric value you want to allow for Number types.
ConstraintSummaries (list) --
Information about the constraints used to provision the product.
(dict) --
Summary information about a constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
UsageInstructions (list) --
Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.
(dict) --
Additional information provided by the administrator.
Type (string) --
The usage instruction type for the value.
Value (string) --
The usage instruction value for this type.
TagOptions (list) --
Information about the TagOptions associated with the resource.
(dict) --
Summary information about a TagOption.
Key (string) --
The TagOption key.
Values (list) --
The TagOption value.
ProvisioningArtifactPreferences (dict) --
An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.
StackSetAccounts (list) --
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 (list) --
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.
ProvisioningArtifactOutputs (list) --
The output of the provisioning artifact.
(dict) --
Provisioning artifact output.
Key (string) --
The provisioning artifact output key.
Description (string) --
Description of the provisioning artifact output key.
ProvisioningArtifactOutputKeys (list) --
A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
(dict) --
Provisioning artifact output.
Key (string) --
The provisioning artifact output key.
Description (string) --
Description of the provisioning artifact output key.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_record(**kwargs)¶Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct , TerminateProvisionedProduct , or UpdateProvisionedProduct ).
Note
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_record(
AcceptLanguage='string',
Id='string',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The record identifier of the provisioned product. This identifier is returned by the request operation.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
},
'RecordOutputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
RecordOutputs (list) --
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.
(dict) --
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.
OutputKey (string) --
The output key.
OutputValue (string) --
The output value.
Description (string) --
The description of the output.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_service_action(**kwargs)¶Describes a self-service action.
See also: AWS API Documentation
Request Syntax
response = client.describe_service_action(
Id='string',
AcceptLanguage='string'
)
[REQUIRED]
The self-service action identifier.
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
Detailed information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_service_action_execution_parameters(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_service_action_execution_parameters(
ProvisionedProductId='string',
ServiceActionId='string',
AcceptLanguage='string'
)
[REQUIRED]
The identifier of the provisioned product.
[REQUIRED]
The self-service action identifier.
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ServiceActionParameters': [
{
'Name': 'string',
'Type': 'string',
'DefaultValues': [
'string',
]
},
]
}
Response Structure
(dict) --
ServiceActionParameters (list) --
The parameters of the self-service action.
(dict) --
Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.
Name (string) --
The name of the execution parameter.
Type (string) --
The execution parameter type.
DefaultValues (list) --
The default values for the execution parameter.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondescribe_tag_option(**kwargs)¶Gets information about the specified TagOption.
See also: AWS API Documentation
Request Syntax
response = client.describe_tag_option(
Id='string'
)
[REQUIRED]
The TagOption identifier.
{
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
}
}
Response Structure
Information about the TagOption.
The TagOption key.
The TagOption value.
The TagOption active state.
The TagOption identifier.
The Amazon Web Services account Id of the owner account that created the TagOption.
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondisable_aws_organizations_access()¶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 .
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.disable_aws_organizations_access()
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptiondisassociate_budget_from_resource(**kwargs)¶Disassociates the specified budget from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_budget_from_resource(
BudgetName='string',
ResourceId='string'
)
[REQUIRED]
The name of the budget you want to disassociate.
[REQUIRED]
The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondisassociate_principal_from_portfolio(**kwargs)¶Disassociates a previously associated principal ARN from a specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_principal_from_portfolio(
AcceptLanguage='string',
PortfolioId='string',
PrincipalARN='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
[REQUIRED]
The ARN of the principal (IAM user, role, or group).
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondisassociate_product_from_portfolio(**kwargs)¶Disassociates the specified product from the specified portfolio.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_product_from_portfolio(
AcceptLanguage='string',
ProductId='string',
PortfolioId='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.ResourceInUseExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptiondisassociate_service_action_from_provisioning_artifact(**kwargs)¶Disassociates the specified self-service action association from the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_service_action_from_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
ServiceActionId='string',
AcceptLanguage='string'
)
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptiondisassociate_tag_option_from_resource(**kwargs)¶Disassociates the specified TagOption from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_tag_option_from_resource(
ResourceId='string',
TagOptionId='string'
)
[REQUIRED]
The resource identifier.
[REQUIRED]
The TagOption identifier.
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionenable_aws_organizations_access()¶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 .
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.enable_aws_organizations_access()
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionexecute_provisioned_product_plan(**kwargs)¶Provisions or modifies a product based on the resource changes for the specified plan.
See also: AWS API Documentation
Request Syntax
response = client.execute_provisioned_product_plan(
AcceptLanguage='string',
PlanId='string',
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The plan identifier.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionexecute_provisioned_product_service_action(**kwargs)¶Executes a self-service action against a provisioned product.
See also: AWS API Documentation
Request Syntax
response = client.execute_provisioned_product_service_action(
ProvisionedProductId='string',
ServiceActionId='string',
ExecuteToken='string',
AcceptLanguage='string',
Parameters={
'string': [
'string',
]
}
)
[REQUIRED]
The identifier of the provisioned product.
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
[REQUIRED]
An idempotency token that uniquely identifies the execute request.
This field is autopopulated if not provided.
The language code.
en - English (default)jp - Japanesezh - ChineseA 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 .
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
An object containing detailed information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionget_aws_organizations_access_status()¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_aws_organizations_access_status()
{
'AccessStatus': 'ENABLED'|'UNDER_CHANGE'|'DISABLED'
}
Response Structure
The status of the portfolio share feature.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_provisioned_product_outputs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.get_provisioned_product_outputs(
AcceptLanguage='string',
ProvisionedProductId='string',
ProvisionedProductName='string',
OutputKeys=[
'string',
],
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe 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.
dict
Response Syntax
{
'Outputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
Outputs (list) --
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.
(dict) --
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.
OutputKey (string) --
The output key.
OutputValue (string) --
The output value.
Description (string) --
The description of the output.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_as_provisioned_product(**kwargs)¶Requests the import of a resource as a Amazon Web Services Service Catalog provisioned product that is associated to a Amazon Web Services Service Catalog product and provisioning artifact. Once imported, all supported Amazon Web Services Service Catalog 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 , IMPORT_ROLLBACK_COMPLETE .
Import of the resource requires that the CloudFormation stack template matches the associated Amazon Web Services Service Catalog product provisioning artifact.
The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions.
See also: AWS API Documentation
Request Syntax
response = client.import_as_provisioned_product(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
ProvisionedProductName='string',
PhysicalId='string',
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The identifier of the provisioning artifact.
[REQUIRED]
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.
[REQUIRED]
The unique identifier of the resource to be imported. It only currently supports CloudFormation stack IDs.
[REQUIRED]
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.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about a request operation.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionLists 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.
See also: AWS API Documentation
Request Syntax
response = client.list_accepted_portfolio_shares(
AcceptLanguage='string',
PageToken='string',
PageSize=123,
PortfolioShareType='IMPORTED'|'AWS_SERVICECATALOG'|'AWS_ORGANIZATIONS'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe 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.dict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionlist_budgets_for_resource(**kwargs)¶Lists all the budgets associated to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_budgets_for_resource(
AcceptLanguage='string',
ResourceId='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The resource identifier.
dict
Response Syntax
{
'Budgets': [
{
'BudgetName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_constraints_for_portfolio(**kwargs)¶Lists the constraints for the specified portfolio and product.
See also: AWS API Documentation
Request Syntax
response = client.list_constraints_for_portfolio(
AcceptLanguage='string',
PortfolioId='string',
ProductId='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{
'ConstraintDetails': [
{
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string',
'ProductId': 'string',
'PortfolioId': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ConstraintDetails (list) --
Information about the constraints.
(dict) --
Information about a constraint.
ConstraintId (string) --
The identifier of the constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Owner (string) --
The owner of the constraint.
ProductId (string) --
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
PortfolioId (string) --
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_launch_paths(**kwargs)¶Lists the paths to the 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.
See also: AWS API Documentation
Request Syntax
response = client.list_launch_paths(
AcceptLanguage='string',
ProductId='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
dict
Response Syntax
{
'LaunchPathSummaries': [
{
'Id': 'string',
'ConstraintSummaries': [
{
'Type': 'string',
'Description': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Name': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
LaunchPathSummaries (list) --
Information about the launch path.
(dict) --
Summary information about a product path for a user.
Id (string) --
The identifier of the product path.
ConstraintSummaries (list) --
The constraints on the portfolio-product relationship.
(dict) --
Summary information about a constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Tags (list) --
The tags associated with this product path.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Name (string) --
The name of the portfolio that contains the product.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionlist_organization_portfolio_access(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_organization_portfolio_access(
AcceptLanguage='string',
PortfolioId='string',
OrganizationNodeType='ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier. For example, port-2abcdext3y5fk .
[REQUIRED]
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.dict
Response Syntax
{
'OrganizationNodes': [
{
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
OrganizationNodes (list) --
Displays information about the organization nodes.
(dict) --
Information about the organization node.
Type (string) --
The organization node type.
Value (string) --
The identifier of the organization node.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionlist_portfolio_access(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_portfolio_access(
AcceptLanguage='string',
PortfolioId='string',
OrganizationParentId='string',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{
'AccountIds': [
'string',
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
AccountIds (list) --
Information about the Amazon Web Services accounts with access to the portfolio.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_portfolios(**kwargs)¶Lists all portfolios in the catalog.
See also: AWS API Documentation
Request Syntax
response = client.list_portfolios(
AcceptLanguage='string',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_portfolios_for_product(**kwargs)¶Lists all portfolios that the specified product is associated with.
See also: AWS API Documentation
Request Syntax
response = client.list_portfolios_for_product(
AcceptLanguage='string',
ProductId='string',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
dict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionlist_principals_for_portfolio(**kwargs)¶Lists all principal ARNs associated with the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.list_principals_for_portfolio(
AcceptLanguage='string',
PortfolioId='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
dict
Response Syntax
{
'Principals': [
{
'PrincipalARN': 'string',
'PrincipalType': 'IAM'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
Principals (list) --
The IAM principals (users or roles) associated with the portfolio.
(dict) --
Information about a principal.
PrincipalARN (string) --
The ARN of the principal (IAM user, role, or group).
PrincipalType (string) --
The principal type. The supported value is IAM .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_provisioned_product_plans(**kwargs)¶Lists the plans for the specified provisioned product or all plans to which the user has access.
See also: AWS API Documentation
Request Syntax
response = client.list_provisioned_product_plans(
AcceptLanguage='string',
ProvisionProductId='string',
PageSize=123,
PageToken='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
dict
Response Syntax
{
'ProvisionedProductPlans': [
{
'PlanName': 'string',
'PlanId': 'string',
'ProvisionProductId': 'string',
'ProvisionProductName': 'string',
'PlanType': 'CLOUDFORMATION',
'ProvisioningArtifactId': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProductPlans (list) --
Information about the plans.
(dict) --
Summary information about a plan.
PlanName (string) --
The name of the plan.
PlanId (string) --
The plan identifier.
ProvisionProductId (string) --
The product identifier.
ProvisionProductName (string) --
The user-friendly name of the provisioned product.
PlanType (string) --
The plan type.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_provisioning_artifacts(**kwargs)¶Lists all provisioning artifacts (also known as versions) for the specified product.
See also: AWS API Documentation
Request Syntax
response = client.list_provisioning_artifacts(
AcceptLanguage='string',
ProductId='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
dict
Response Syntax
{
'ProvisioningArtifactDetails': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactDetails (list) --
Information about the provisioning artifacts.
(dict) --
Information about a provisioning artifact (also known as a version) for a product.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesCreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_provisioning_artifacts_for_service_action(**kwargs)¶Lists all provisioning artifacts (also known as versions) for the specified self-service action.
See also: AWS API Documentation
Request Syntax
response = client.list_provisioning_artifacts_for_service_action(
ServiceActionId='string',
PageSize=123,
PageToken='string',
AcceptLanguage='string'
)
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ProvisioningArtifactViews': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifact': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
}
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactViews (list) --
An array of objects with information about product views and provisioning artifacts.
(dict) --
An object that contains summary information about a product view and a provisioning artifact.
ProductViewSummary (dict) --
Summary information about a product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifact (dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_record_history(**kwargs)¶Lists the specified requests or all performed requests.
See also: AWS API Documentation
Request Syntax
response = client.list_record_history(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
SearchFilter={
'Key': 'string',
'Value': 'string'
},
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
The search filter to scope the results.
The filter key.
product - Filter results based on the specified product identifier.provisionedproduct - Filter results based on the provisioned product identifier.The filter value.
dict
Response Syntax
{
'RecordDetails': [
{
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetails (list) --
The records, in reverse chronological order.
(dict) --
Information about a request operation.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_resources_for_tag_option(**kwargs)¶Lists the resources associated with the specified TagOption.
See also: AWS API Documentation
Request Syntax
response = client.list_resources_for_tag_option(
TagOptionId='string',
ResourceType='string',
PageSize=123,
PageToken='string'
)
[REQUIRED]
The TagOption identifier.
The resource type.
PortfolioProductdict
Response Syntax
{
'ResourceDetails': [
{
'Id': 'string',
'ARN': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'PageToken': 'string'
}
Response Structure
(dict) --
ResourceDetails (list) --
Information about the resources.
(dict) --
Information about a resource.
Id (string) --
The identifier of the resource.
ARN (string) --
The ARN of the resource.
Name (string) --
The name of the resource.
Description (string) --
The description of the resource.
CreatedTime (datetime) --
The creation time of the resource.
PageToken (string) --
The page token for the next set of results. To retrieve the first set of results, use null.
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_service_actions(**kwargs)¶Lists all self-service actions.
See also: AWS API Documentation
Request Syntax
response = client.list_service_actions(
AcceptLanguage='string',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_service_actions_for_provisioning_artifact(**kwargs)¶Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.
See also: AWS API Documentation
Request Syntax
response = client.list_service_actions_for_provisioning_artifact(
ProductId='string',
ProvisioningArtifactId='string',
PageSize=123,
PageToken='string',
AcceptLanguage='string'
)
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the self-service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionlist_stack_instances_for_provisioned_product(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_stack_instances_for_provisioned_product(
AcceptLanguage='string',
ProvisionedProductId='string',
PageToken='string',
PageSize=123
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The identifier of the provisioned product.
dict
Response Syntax
{
'StackInstances': [
{
'Account': 'string',
'Region': 'string',
'StackInstanceStatus': 'CURRENT'|'OUTDATED'|'INOPERABLE'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
StackInstances (list) --
List of stack instances.
(dict) --
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.
Account (string) --
The name of the Amazon Web Services account that the stack instance is associated with.
Region (string) --
The name of the Amazon Web Services Region that the stack instance is associated with.
StackInstanceStatus (string) --
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.NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionlist_tag_options(**kwargs)¶Lists the specified TagOptions or all TagOptions.
See also: AWS API Documentation
Request Syntax
response = client.list_tag_options(
Filters={
'Key': 'string',
'Value': 'string',
'Active': True|False
},
PageSize=123,
PageToken='string'
)
The search filters. If no search filters are specified, the output includes all TagOptions.
The TagOption key.
The TagOption value.
The active state.
dict
Response Syntax
{
'TagOptionDetails': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
},
],
'PageToken': 'string'
}
Response Structure
(dict) --
TagOptionDetails (list) --
Information about the TagOptions.
(dict) --
Information about a TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
PageToken (string) --
The page token for the next set of results. To retrieve the first set of results, use null.
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionprovision_product(**kwargs)¶Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a 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 is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N ]:Value ".
See also: AWS API Documentation
Request Syntax
response = client.provision_product(
AcceptLanguage='string',
ProductId='string',
ProductName='string',
ProvisioningArtifactId='string',
ProvisioningArtifactName='string',
PathId='string',
PathName='string',
ProvisionedProductName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string'
},
],
ProvisioningPreferences={
'StackSetAccounts': [
'string',
],
'StackSetRegions': [
'string',
],
'StackSetFailureToleranceCount': 123,
'StackSetFailureTolerancePercentage': 123,
'StackSetMaxConcurrencyCount': 123,
'StackSetMaxConcurrencyPercentage': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationArns=[
'string',
],
ProvisionToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
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.
Parameters specified by the administrator that are required for provisioning the product.
Information about a parameter used to provision a product.
The parameter key.
The parameter value.
An object that contains information about the provisioning preferences for a stack set.
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.
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.
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.
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.
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.
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.
One or more tags.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
[REQUIRED]
An idempotency token that uniquely identifies the provisioning request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionRejects an offer to share the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.reject_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
PortfolioShareType='IMPORTED'|'AWS_SERVICECATALOG'|'AWS_ORGANIZATIONS'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
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
dict
Response Syntax
{}
Response Structure
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionscan_provisioned_products(**kwargs)¶Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts .
See also: AWS API Documentation
Request Syntax
response = client.scan_provisioned_products(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'LaunchRoleArn': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
Information about the provisioned products.
(dict) --
Information about a provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for 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 (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionsearch_products(**kwargs)¶Gets information about the products to which the caller has access.
See also: AWS API Documentation
Request Syntax
response = client.search_products(
AcceptLanguage='string',
Filters={
'string': [
'string',
]
},
PageSize=123,
SortBy='Title'|'VersionCount'|'CreationDate',
SortOrder='ASCENDING'|'DESCENDING',
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe search filters. If no search filters are specified, the output includes all products to which the caller has access.
dict
Response Syntax
{
'ProductViewSummaries': [
{
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
],
'ProductViewAggregations': {
'string': [
{
'Value': 'string',
'ApproximateCount': 123
},
]
},
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewSummaries (list) --
Information about the product views.
(dict) --
Summary information about a product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProductViewAggregations (dict) --
The product view aggregations.
(string) --
(list) --
(dict) --
A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
Value (string) --
The value of the product view aggregation.
ApproximateCount (integer) --
An approximate count of the products that match the value.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionsearch_products_as_admin(**kwargs)¶Gets information about the products for the specified portfolio or all products.
See also: AWS API Documentation
Request Syntax
response = client.search_products_as_admin(
AcceptLanguage='string',
PortfolioId='string',
Filters={
'string': [
'string',
]
},
SortBy='Title'|'VersionCount'|'CreationDate',
SortOrder='ASCENDING'|'DESCENDING',
PageToken='string',
PageSize=123,
ProductSource='ACCOUNT'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe search filters. If no search filters are specified, the output includes all products to which the administrator has access.
dict
Response Syntax
{
'ProductViewDetails': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewDetails (list) --
Information about the product views.
(dict) --
Information about a product view.
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
The status of the product.
AVAILABLE - The product is ready for use.CREATING - Product creation has started; the product is not ready for use.FAILED - An action failed.ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionsearch_provisioned_products(**kwargs)¶Gets information about the provisioned products that meet the specified criteria.
Note
To ensure a complete list of provisioned products and remove duplicate products, use sort-by createdTime .
aws servicecatalog search-provisioned-products --sort-by createdTime
See also: AWS API Documentation
Request Syntax
response = client.search_provisioned_products(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
Filters={
'string': [
'string',
]
},
SortBy='string',
SortOrder='ASCENDING'|'DESCENDING',
PageSize=123,
PageToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
The search filters.
When the key is SearchQuery , the searchable fields are arn , createdTime , id , lastRecordId , idempotencyToken , name , physicalId , productId , provisioningArtifact , type , status , tags , userArn , userArnSession , lastProvisioningRecordId , lastSuccessfulProvisioningRecordId , productName , and provisioningArtifactName .
Example: "SearchQuery":["status:AVAILABLE"]
arn , id , name , and lastRecordId .dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'PhysicalId': 'string',
'ProductId': 'string',
'ProductName': 'string',
'ProvisioningArtifactId': 'string',
'ProvisioningArtifactName': 'string',
'UserArn': 'string',
'UserArnSession': 'string'
},
],
'TotalResultsCount': 123,
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
Information about the provisioned products.
(dict) --
Information about a provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for 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 (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
Tags (list) --
One or more tags.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
PhysicalId (string) --
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
ProductId (string) --
The product identifier.
ProductName (string) --
The name of the product.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
ProvisioningArtifactName (string) --
The name of the provisioning artifact.
UserArn (string) --
The Amazon Resource Name (ARN) of the IAM user.
UserArnSession (string) --
The ARN of the IAM user in the session. This ARN might contain a session ID.
TotalResultsCount (integer) --
The number of provisioned products found.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionterminate_provisioned_product(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.terminate_provisioned_product(
ProvisionedProductName='string',
ProvisionedProductId='string',
TerminateToken='string',
IgnoreErrors=True|False,
AcceptLanguage='string',
RetainPhysicalResources=True|False
)
ProvisionedProductName and ProvisionedProductId .ProvisionedProductName and ProvisionedProductId .[REQUIRED]
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 .
This field is autopopulated if not provided.
The language code.
en - English (default)jp - Japanesezh - ChineseTerminateProvisionedProduct 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.dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of this request.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionupdate_constraint(**kwargs)¶Updates the specified constraint.
See also: AWS API Documentation
Request Syntax
response = client.update_constraint(
AcceptLanguage='string',
Id='string',
Description='string',
Parameters='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The identifier of the constraint.
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.
Note
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 .
dict
Response Syntax
{
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string',
'ProductId': 'string',
'PortfolioId': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ConstraintDetail (dict) --
Information about the constraint.
ConstraintId (string) --
The identifier of the constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Owner (string) --
The owner of the constraint.
ProductId (string) --
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
PortfolioId (string) --
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
ConstraintParameters (string) --
The constraint parameters.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionupdate_portfolio(**kwargs)¶Updates the specified portfolio.
You cannot update a product that was shared with you.
See also: AWS API Documentation
Request Syntax
response = client.update_portfolio(
AcceptLanguage='string',
Id='string',
DisplayName='string',
Description='string',
ProviderName='string',
AddTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveTags=[
'string',
]
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
The tags to add.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
The tags to remove.
dict
Response Syntax
{
'PortfolioDetail': {
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
PortfolioDetail (dict) --
Information about the portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
Tags (list) --
Information about the tags associated with the portfolio.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.LimitExceededExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionUpdates the specified portfolio share. You can use this API to enable or disable TagOptions 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.
See also: AWS API Documentation
Request Syntax
response = client.update_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string',
OrganizationNode={
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
},
ShareTagOptions=True|False
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The unique identifier of the portfolio for which the share will be updated.
Information about the organization node.
The organization node type.
The identifier of the organization node.
dict
Response Syntax
{
'PortfolioShareToken': 'string',
'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'ERROR'
}
Response Structure
(dict) --
PortfolioShareToken (string) --
The token that tracks the status of the UpdatePortfolioShare operation for external account to account or organizational type sharing.
Status (string) --
The status of UpdatePortfolioShare operation. You can also obtain the operation status using DescribePortfolioShareStatus API.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.OperationNotSupportedExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionupdate_product(**kwargs)¶Updates the specified product.
See also: AWS API Documentation
Request Syntax
response = client.update_product(
AcceptLanguage='string',
Id='string',
Name='string',
Owner='string',
Description='string',
Distributor='string',
SupportDescription='string',
SupportEmail='string',
SupportUrl='string',
AddTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveTags=[
'string',
]
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
The tags to add to the product.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
The tags to remove from the product.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
The status of the product.
AVAILABLE - The product is ready for use.CREATING - Product creation has started; the product is not ready for use.FAILED - An action failed.ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Tags (list) --
Information about the tags associated with the product.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionupdate_provisioned_product(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.update_provisioned_product(
AcceptLanguage='string',
ProvisionedProductName='string',
ProvisionedProductId='string',
ProductId='string',
ProductName='string',
ProvisioningArtifactId='string',
ProvisioningArtifactName='string',
PathId='string',
PathName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
ProvisioningPreferences={
'StackSetAccounts': [
'string',
],
'StackSetRegions': [
'string',
],
'StackSetFailureToleranceCount': 123,
'StackSetFailureTolerancePercentage': 123,
'StackSetMaxConcurrencyCount': 123,
'StackSetMaxConcurrencyPercentage': 123,
'StackSetOperationType': 'CREATE'|'UPDATE'|'DELETE'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
UpdateToken='string'
)
The language code.
en - English (default)jp - Japanesezh - ChineseProvisionedProductName and ProvisionedProductId .The new parameters.
The parameter key-value pair used to update a provisioned product.
The parameter key.
The parameter value.
If set to true, Value is ignored and the previous parameter value is kept.
An object that contains information about the provisioning preferences for a stack set.
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.
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.
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.
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.
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.
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.
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.
One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
The tag key.
The value for this key.
[REQUIRED]
The idempotency token that uniquely identifies the provisioning update request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of the request.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionupdate_provisioned_product_properties(**kwargs)¶Requests updates to the properties of the specified provisioned product.
See also: AWS API Documentation
Request Syntax
response = client.update_provisioned_product_properties(
AcceptLanguage='string',
ProvisionedProductId='string',
ProvisionedProductProperties={
'string': 'string'
},
IdempotencyToken='string'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The identifier of the provisioned product.
[REQUIRED]
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 IAM user ARNs, IAM role ARNs, and STS assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and execute service actions in the provisioned product.
The administrator can change the owner of a provisioned product to another IAM or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the 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.
[REQUIRED]
The idempotency token that uniquely identifies the provisioning product update request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProvisionedProductId': 'string',
'ProvisionedProductProperties': {
'string': 'string'
},
'RecordId': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED'
}
Response Structure
(dict) --
ProvisionedProductId (string) --
The provisioned product identifier.
ProvisionedProductProperties (dict) --
A map that contains the properties updated.
RecordId (string) --
The identifier of the record.
Status (string) --
The status of the request.
Exceptions
ServiceCatalog.Client.exceptions.InvalidParametersExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidStateExceptionupdate_provisioning_artifact(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.update_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
Name='string',
Description='string',
Active=True|False,
Guidance='DEFAULT'|'DEPRECATED'
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
[REQUIRED]
The identifier of the provisioning artifact.
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.
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.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation templateMARKETPLACE_AMI - Amazon Web Services Marketplace AMIMARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services ResourcesCreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Info (dict) --
The URL of the CloudFormation template in Amazon S3, Amazon Web Services CodeCommit, or GitHub in JSON format.
Status (string) --
The status of the current request.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionupdate_service_action(**kwargs)¶Updates a self-service action.
See also: AWS API Documentation
Request Syntax
response = client.update_service_action(
Id='string',
Name='string',
Definition={
'string': 'string'
},
Description='string',
AcceptLanguage='string'
)
[REQUIRED]
The self-service action identifier.
A map that defines the self-service action.
The language code.
en - English (default)jp - Japanesezh - Chinesedict
Response Syntax
{
'ServiceActionDetail': {
'ServiceActionSummary': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
'Definition': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ServiceActionDetail (dict) --
Detailed information about the self-service action.
ServiceActionSummary (dict) --
Summary information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
Definition (dict) --
A map that defines the self-service action.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionupdate_tag_option(**kwargs)¶Updates the specified TagOption.
See also: AWS API Documentation
Request Syntax
response = client.update_tag_option(
Id='string',
Value='string',
Active=True|False
)
[REQUIRED]
The TagOption identifier.
dict
Response Syntax
{
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
}
}
Response Structure
(dict) --
TagOptionDetail (dict) --
Information about the TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
Exceptions
ServiceCatalog.Client.exceptions.TagOptionNotMigratedExceptionServiceCatalog.Client.exceptions.ResourceNotFoundExceptionServiceCatalog.Client.exceptions.DuplicateResourceExceptionServiceCatalog.Client.exceptions.InvalidParametersExceptionThe available paginators are:
ServiceCatalog.Paginator.ListAcceptedPortfolioSharesServiceCatalog.Paginator.ListConstraintsForPortfolioServiceCatalog.Paginator.ListLaunchPathsServiceCatalog.Paginator.ListOrganizationPortfolioAccessServiceCatalog.Paginator.ListPortfoliosServiceCatalog.Paginator.ListPortfoliosForProductServiceCatalog.Paginator.ListPrincipalsForPortfolioServiceCatalog.Paginator.ListProvisionedProductPlansServiceCatalog.Paginator.ListProvisioningArtifactsForServiceActionServiceCatalog.Paginator.ListRecordHistoryServiceCatalog.Paginator.ListResourcesForTagOptionServiceCatalog.Paginator.ListServiceActionsServiceCatalog.Paginator.ListServiceActionsForProvisioningArtifactServiceCatalog.Paginator.ListTagOptionsServiceCatalog.Paginator.ScanProvisionedProductsServiceCatalog.Paginator.SearchProductsAsAdminpaginator = client.get_paginator('list_accepted_portfolio_shares')
Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_accepted_portfolio_shares().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioShareType='IMPORTED'|'AWS_SERVICECATALOG'|'AWS_ORGANIZATIONS',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe 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.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListConstraintsForPortfolio¶paginator = client.get_paginator('list_constraints_for_portfolio')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_constraints_for_portfolio().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioId='string',
ProductId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConstraintDetails': [
{
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string',
'ProductId': 'string',
'PortfolioId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConstraintDetails (list) --
Information about the constraints.
(dict) --
Information about a constraint.
ConstraintId (string) --
The identifier of the constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Owner (string) --
The owner of the constraint.
ProductId (string) --
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.
PortfolioId (string) --
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListLaunchPaths¶paginator = client.get_paginator('list_launch_paths')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_launch_paths().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
ProductId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LaunchPathSummaries': [
{
'Id': 'string',
'ConstraintSummaries': [
{
'Type': 'string',
'Description': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LaunchPathSummaries (list) --
Information about the launch path.
(dict) --
Summary information about a product path for a user.
Id (string) --
The identifier of the product path.
ConstraintSummaries (list) --
The constraints on the portfolio-product relationship.
(dict) --
Summary information about a constraint.
Type (string) --
The type of constraint.
LAUNCHNOTIFICATIONTEMPLATEDescription (string) --
The description of the constraint.
Tags (list) --
The tags associated with this product path.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) --
The tag key.
Value (string) --
The value for this key.
Name (string) --
The name of the portfolio that contains the product.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListOrganizationPortfolioAccess¶paginator = client.get_paginator('list_organization_portfolio_access')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_organization_portfolio_access().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioId='string',
OrganizationNodeType='ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier. For example, port-2abcdext3y5fk .
[REQUIRED]
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.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationNodes': [
{
'Type': 'ORGANIZATION'|'ORGANIZATIONAL_UNIT'|'ACCOUNT',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationNodes (list) --
Displays information about the organization nodes.
(dict) --
Information about the organization node.
Type (string) --
The organization node type.
Value (string) --
The identifier of the organization node.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListPortfolios¶paginator = client.get_paginator('list_portfolios')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_portfolios().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListPortfoliosForProduct¶paginator = client.get_paginator('list_portfolios_for_product')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_portfolios_for_product().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
ProductId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The product identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PortfolioDetails (list) --
Information about the portfolios.
(dict) --
Information about a portfolio.
Id (string) --
The portfolio identifier.
ARN (string) --
The ARN assigned to the portfolio.
DisplayName (string) --
The name to use for display purposes.
Description (string) --
The description of the portfolio.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProviderName (string) --
The name of the portfolio provider.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListPrincipalsForPortfolio¶paginator = client.get_paginator('list_principals_for_portfolio')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_principals_for_portfolio().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - Chinese[REQUIRED]
The portfolio identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Principals': [
{
'PrincipalARN': 'string',
'PrincipalType': 'IAM'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Principals (list) --
The IAM principals (users or roles) associated with the portfolio.
(dict) --
Information about a principal.
PrincipalARN (string) --
The ARN of the principal (IAM user, role, or group).
PrincipalType (string) --
The principal type. The supported value is IAM .
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListProvisionedProductPlans¶paginator = client.get_paginator('list_provisioned_product_plans')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_provisioned_product_plans().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
ProvisionProductId='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ProvisionedProductPlans': [
{
'PlanName': 'string',
'PlanId': 'string',
'ProvisionProductId': 'string',
'ProvisionProductName': 'string',
'PlanType': 'CLOUDFORMATION',
'ProvisioningArtifactId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProvisionedProductPlans (list) --
Information about the plans.
(dict) --
Summary information about a plan.
PlanName (string) --
The name of the plan.
PlanId (string) --
The plan identifier.
ProvisionProductId (string) --
The product identifier.
ProvisionProductName (string) --
The user-friendly name of the provisioned product.
PlanType (string) --
The plan type.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListProvisioningArtifactsForServiceAction¶paginator = client.get_paginator('list_provisioning_artifacts_for_service_action')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_provisioning_artifacts_for_service_action().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceActionId='string',
AcceptLanguage='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
The language code.
en - English (default)jp - Japanesezh - ChineseA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ProvisioningArtifactViews': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifact': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactViews (list) --
An array of objects with information about product views and provisioning artifacts.
(dict) --
An object that contains summary information about a product view and a provisioning artifact.
ProductViewSummary (dict) --
Summary information about a product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifact (dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListRecordHistory¶paginator = client.get_paginator('list_record_history')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_record_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
SearchFilter={
'Key': 'string',
'Value': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
The search filter to scope the results.
The filter key.
product - Filter results based on the specified product identifier.provisionedproduct - Filter results based on the provisioned product identifier.The filter value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RecordDetails': [
{
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RecordDetails (list) --
The records, in reverse chronological order.
(dict) --
Information about a request operation.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.IN_PROGRESS - The requested operation is in progress.IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.SUCCEEDED - The requested operation has successfully completed.FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCTUPDATE_PROVISIONED_PRODUCTTERMINATE_PROVISIONED_PRODUCTProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListResourcesForTagOption¶paginator = client.get_paginator('list_resources_for_tag_option')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_resources_for_tag_option().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TagOptionId='string',
ResourceType='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The TagOption identifier.
The resource type.
PortfolioProductA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceDetails': [
{
'Id': 'string',
'ARN': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceDetails (list) --
Information about the resources.
(dict) --
Information about a resource.
Id (string) --
The identifier of the resource.
ARN (string) --
The ARN of the resource.
Name (string) --
The name of the resource.
Description (string) --
The description of the resource.
CreatedTime (datetime) --
The creation time of the resource.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListServiceActions¶paginator = client.get_paginator('list_service_actions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_service_actions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListServiceActionsForProvisioningArtifact¶paginator = client.get_paginator('list_service_actions_for_provisioning_artifact')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_service_actions_for_provisioning_artifact().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ProductId='string',
ProvisioningArtifactId='string',
AcceptLanguage='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The product identifier. For example, prod-abcdzk7xy33qa .
[REQUIRED]
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
The language code.
en - English (default)jp - Japanesezh - ChineseA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ServiceActionSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'DefinitionType': 'SSM_AUTOMATION'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceActionSummaries (list) --
An object containing information about the self-service actions associated with the provisioning artifact.
(dict) --
Detailed information about the self-service action.
Id (string) --
The self-service action identifier.
Name (string) --
The self-service action name.
Description (string) --
The self-service action description.
DefinitionType (string) --
The self-service action definition type. For example, SSM_AUTOMATION .
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ListTagOptions¶paginator = client.get_paginator('list_tag_options')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_tag_options().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters={
'Key': 'string',
'Value': 'string',
'Active': True|False
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The search filters. If no search filters are specified, the output includes all TagOptions.
The TagOption key.
The TagOption value.
The active state.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TagOptionDetails': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TagOptionDetails (list) --
Information about the TagOptions.
(dict) --
Information about a TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.ScanProvisionedProducts¶paginator = client.get_paginator('scan_provisioned_products')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.scan_provisioned_products().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe access level to use to obtain results. The default is User .
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.The user to which the access level applies. The only supported value is Self .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'LaunchRoleArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
Information about the provisioned products.
(dict) --
Information about a provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for 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 (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextToken (string) --
A token to resume pagination.
ServiceCatalog.Paginator.SearchProductsAsAdmin¶paginator = client.get_paginator('search_products_as_admin')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ServiceCatalog.Client.search_products_as_admin().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AcceptLanguage='string',
PortfolioId='string',
Filters={
'string': [
'string',
]
},
SortBy='Title'|'VersionCount'|'CreationDate',
SortOrder='ASCENDING'|'DESCENDING',
ProductSource='ACCOUNT',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The language code.
en - English (default)jp - Japanesezh - ChineseThe search filters. If no search filters are specified, the output includes all products to which the administrator has access.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ProductViewDetails': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProductViewDetails (list) --
Information about the product views.
(dict) --
Information about a product view.
ProductViewSummary (dict) --
Summary information about the product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
The status of the product.
AVAILABLE - The product is ready for use.CREATING - Product creation has started; the product is not ready for use.FAILED - An action failed.ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
NextToken (string) --
A token to resume pagination.