Table of Contents
ServiceCatalog.Client¶A low-level client representing AWS Service Catalog:
client = session.create_client('servicecatalog')
These are the available methods:
accept_portfolio_share()associate_principal_with_portfolio()associate_product_with_portfolio()associate_tag_option_with_resource()can_paginate()create_constraint()create_portfolio()create_portfolio_share()create_product()create_provisioning_artifact()create_tag_option()delete_constraint()delete_portfolio()delete_portfolio_share()delete_product()delete_provisioning_artifact()describe_constraint()describe_portfolio()describe_product()describe_product_as_admin()describe_product_view()describe_provisioned_product()describe_provisioning_artifact()describe_provisioning_parameters()describe_record()describe_tag_option()disassociate_principal_from_portfolio()disassociate_product_from_portfolio()disassociate_tag_option_from_resource()generate_presigned_url()get_paginator()get_waiter()list_accepted_portfolio_shares()list_constraints_for_portfolio()list_launch_paths()list_portfolio_access()list_portfolios()list_portfolios_for_product()list_principals_for_portfolio()list_provisioning_artifacts()list_record_history()list_resources_for_tag_option()list_tag_options()provision_product()reject_portfolio_share()scan_provisioned_products()search_products()search_products_as_admin()terminate_provisioned_product()update_constraint()update_portfolio()update_product()update_provisioned_product()update_provisioning_artifact()update_tag_option()Accepts an offer to share a portfolio.
See also: AWS API Documentation
Request Syntax
response = client.accept_portfolio_share(
AcceptLanguage='string',
PortfolioId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
associate_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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
associate_product_with_portfolio(**kwargs)¶Associates a product with a portfolio.
See also: AWS API Documentation
Request Syntax
response = client.associate_product_with_portfolio(
AcceptLanguage='string',
ProductId='string',
PortfolioId='string',
SourcePortfolioId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
associate_tag_option_with_resource(**kwargs)¶Associate a TagOption identifier with a resource identifier.
See also: AWS API Documentation
Request Syntax
response = client.associate_tag_option_with_resource(
ResourceId='string',
TagOptionId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
create_constraint(**kwargs)¶Creates a new constraint. For more information, see Using Constraints .
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
create_portfolio(**kwargs)¶Creates a new portfolio.
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
Creates a new portfolio share.
See also: AWS API Documentation
Request Syntax
response = client.create_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
create_product(**kwargs)¶Creates a new product.
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'
},
IdempotencyToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
|
create_provisioning_artifact(**kwargs)¶Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
See the bottom of this topic for an example JSON request.
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'
},
IdempotencyToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
create_tag_option(**kwargs)¶Create a new TagOption.
See also: AWS API Documentation
Request Syntax
response = client.create_tag_option(
Key='string',
Value='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string'
}
}
Response Structure
|
delete_constraint(**kwargs)¶Deletes the specified constraint.
See also: AWS API Documentation
Request Syntax
response = client.delete_constraint(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_portfolio(**kwargs)¶Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.
See also: AWS API Documentation
Request Syntax
response = client.delete_portfolio(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
Deletes the specified portfolio share.
See also: AWS API Documentation
Request Syntax
response = client.delete_portfolio_share(
AcceptLanguage='string',
PortfolioId='string',
AccountId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_product(**kwargs)¶Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.
See also: AWS API Documentation
Request Syntax
response = client.delete_product(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
delete_provisioning_artifact(**kwargs)¶Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).
See also: AWS API Documentation
Request Syntax
response = client.delete_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
describe_constraint(**kwargs)¶Retrieves detailed information for a specified constraint.
See also: AWS API Documentation
Request Syntax
response = client.describe_constraint(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
describe_portfolio(**kwargs)¶Retrieves detailed information and any tags associated with the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.describe_portfolio(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
Response Structure
|
describe_product(**kwargs)¶Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId .
See also: AWS API Documentation
Request Syntax
response = client.describe_product(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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)
},
]
}
Response Structure
|
describe_product_as_admin(**kwargs)¶Retrieves information about a specified product, run with administrator access.
See also: AWS API Documentation
Request Syntax
response = client.describe_product_as_admin(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
Response Structure
|
describe_product_view(**kwargs)¶Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId .
See also: AWS API Documentation
Request Syntax
response = client.describe_product_view(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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)
},
]
}
Response Structure
|
describe_provisioned_product(**kwargs)¶Retrieve detailed information about the provisioned product.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioned_product(
AcceptLanguage='string',
Id='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisionedProductDetail': {
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string'
}
}
Response Structure
|
describe_provisioning_artifact(**kwargs)¶Retrieves detailed information about the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioning_artifact(
AcceptLanguage='string',
ProvisioningArtifactId='string',
ProductId='string',
Verbose=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
describe_provisioning_parameters(**kwargs)¶Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.
If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to the ProvisionProduct operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct with empty TagOption values cause the error “Parameter validation failed: Missing required parameter in Tags[N ]:Value “. Calls to ProvisionProduct with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value “sc-tagoption-conflict-portfolioId-productId “.
See also: AWS API Documentation
Request Syntax
response = client.describe_provisioning_parameters(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
PathId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisioningArtifactParameters': [
{
'ParameterKey': 'string',
'DefaultValue': 'string',
'ParameterType': 'string',
'IsNoEcho': True|False,
'Description': 'string',
'ParameterConstraints': {
'AllowedValues': [
'string',
]
}
},
],
'ConstraintSummaries': [
{
'Type': 'string',
'Description': 'string'
},
],
'UsageInstructions': [
{
'Type': 'string',
'Value': 'string'
},
],
'TagOptions': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
}
Response Structure
|
describe_record(**kwargs)¶Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation ( ProvisionProduct , TerminateProvisionedProduct , or UpdateProvisionedProduct ).
See also: AWS API Documentation
Request Syntax
response = client.describe_record(
AcceptLanguage='string',
Id='string',
PageToken='string',
PageSize=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
},
'RecordOutputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
describe_tag_option(**kwargs)¶Describes a TagOption.
See also: AWS API Documentation
Request Syntax
response = client.describe_tag_option(
Id='string'
)
| Parameters: | Id (string) – [REQUIRED] The identifier of the TagOption. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string'
}
}
Response Structure
|
disassociate_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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
disassociate_product_from_portfolio(**kwargs)¶Disassociates the specified product from the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_product_from_portfolio(
AcceptLanguage='string',
ProductId='string',
PortfolioId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
disassociate_tag_option_from_resource(**kwargs)¶Disassociates a TagOption from a resource.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_tag_option_from_resource(
ResourceId='string',
TagOptionId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶Lists details of all portfolios for which sharing was accepted by this account.
See also: AWS API Documentation
Request Syntax
response = client.list_accepted_portfolio_shares(
AcceptLanguage='string',
PageToken='string',
PageSize=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_constraints_for_portfolio(**kwargs)¶Retrieves detailed constraint information 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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ConstraintDetails': [
{
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_launch_paths(**kwargs)¶Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.
See also: AWS API Documentation
Request Syntax
response = client.list_launch_paths(
AcceptLanguage='string',
ProductId='string',
PageSize=123,
PageToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'LaunchPathSummaries': [
{
'Id': 'string',
'ConstraintSummaries': [
{
'Type': 'string',
'Description': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'Name': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_portfolio_access(**kwargs)¶Lists the account IDs that have been authorized sharing of the specified portfolio.
See also: AWS API Documentation
Request Syntax
response = client.list_portfolio_access(
AcceptLanguage='string',
PortfolioId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'AccountIds': [
'string',
],
'NextPageToken': 'string'
}
Response Structure
|
list_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
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_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
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'PortfolioDetails': [
{
'Id': 'string',
'ARN': 'string',
'DisplayName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProviderName': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'Principals': [
{
'PrincipalARN': 'string',
'PrincipalType': 'IAM'
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_provisioning_artifacts(**kwargs)¶Lists all provisioning artifacts associated with the specified product.
See also: AWS API Documentation
Request Syntax
response = client.list_provisioning_artifacts(
AcceptLanguage='string',
ProductId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisioningArtifactDetails': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_record_history(**kwargs)¶Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
},
],
'NextPageToken': 'string'
}
Response Structure
|
list_resources_for_tag_option(**kwargs)¶Lists resources associated with a TagOption.
See also: AWS API Documentation
Request Syntax
response = client.list_resources_for_tag_option(
TagOptionId='string',
ResourceType='string',
PageSize=123,
PageToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ResourceDetails': [
{
'Id': 'string',
'ARN': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'PageToken': 'string'
}
Response Structure
|
list_tag_options(**kwargs)¶Lists detailed TagOptions information.
See also: AWS API Documentation
Request Syntax
response = client.list_tag_options(
Filters={
'Key': 'string',
'Value': 'string',
'Active': True|False
},
PageSize=123,
PageToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TagOptionDetails': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string'
},
],
'PageToken': 'string'
}
Response Structure
|
provision_product(**kwargs)¶Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation. The error “Parameter validation failed: Missing required parameter in Tags[N ]:Value ” indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters .
See also: AWS API Documentation
Request Syntax
response = client.provision_product(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
PathId='string',
ProvisionedProductName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationArns=[
'string',
],
ProvisionToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
}
Response Structure
|
Rejects an offer to share a portfolio.
See also: AWS API Documentation
Request Syntax
response = client.reject_portfolio_share(
AcceptLanguage='string',
PortfolioId='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
scan_provisioned_products(**kwargs)¶Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
|
search_products(**kwargs)¶Returns a paginated list all of the Products objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView .
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
search_products_as_admin(**kwargs)¶Retrieves summary and status information about all products created within the caller’s account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.
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'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
terminate_provisioned_product(**kwargs)¶Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
See also: AWS API Documentation
Request Syntax
response = client.terminate_provisioned_product(
ProvisionedProductName='string',
ProvisionedProductId='string',
TerminateToken='string',
IgnoreErrors=True|False,
AcceptLanguage='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
}
Response Structure
|
update_constraint(**kwargs)¶Updates an existing constraint.
See also: AWS API Documentation
Request Syntax
response = client.update_constraint(
AcceptLanguage='string',
Id='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ConstraintDetail': {
'ConstraintId': 'string',
'Type': 'string',
'Description': 'string',
'Owner': 'string'
},
'ConstraintParameters': 'string',
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
update_portfolio(**kwargs)¶Updates the specified portfolio’s details. This operation does not work with a product that has been 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',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
update_product(**kwargs)¶Updates an existing 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',
]
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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
|
update_provisioned_product(**kwargs)¶Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
See also: AWS API Documentation
Request Syntax
response = client.update_provisioned_product(
AcceptLanguage='string',
ProvisionedProductName='string',
ProvisionedProductId='string',
ProductId='string',
ProvisioningArtifactId='string',
PathId='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
UpdateToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | 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'
},
]
}
}
Response Structure
|
update_provisioning_artifact(**kwargs)¶Updates an existing provisioning artifact’s information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.
See also: AWS API Documentation
Request Syntax
response = client.update_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
Name='string',
Description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
|
update_tag_option(**kwargs)¶Updates an existing TagOption.
See also: AWS API Documentation
Request Syntax
response = client.update_tag_option(
Id='string',
Value='string',
Active=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'TagOptionDetail': {
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string'
}
}
Response Structure
|
The available paginators are: