provisioned_products

Creates, updates, deletes, gets or lists a provisioned_products resource.

Overview

Name	provisioned_products
Type	Resource
Id	aws.servicecatalog.provisioned_products

Fields

The following fields are returned by SELECT queries:

describe_provisioned_product

Name	Datatype	Description
cloud_watch_dashboards	array	Any CloudWatch dashboards that were created when provisioning the product.
provisioned_product_detail	object	Information about the provisioned product.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_provisioned_product	select	region		Gets information about the specified provisioned product.
update_provisioned_product_properties	update	region, ProvisionedProductId, ProvisionedProductProperties, IdempotencyToken		Requests updates to the properties of the specified provisioned product.
update_provisioned_product	update	region, UpdateToken		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.
terminate_provisioned_product	delete	region		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.
execute_provisioned_product_service_action	exec	region, ProvisionedProductId, ServiceActionId, ExecuteToken		Executes a self-service action against a provisioned product.
scan_provisioned_products	exec	region		Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts.
search_provisioned_products	exec	region		Gets information about the provisioned products that meet the specified criteria.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_provisioned_product

Gets information about the specified provisioned product.

SELECT
cloud_watch_dashboards,
provisioned_product_detail
FROM aws.servicecatalog.provisioned_products
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_provisioned_product_properties

Requests updates to the properties of the specified provisioned product.

UPDATE aws.servicecatalog.provisioned_products
SET 
AcceptLanguage = '{{ AcceptLanguage }}',
ProvisionedProductId = '{{ ProvisionedProductId }}',
ProvisionedProductProperties = '{{ ProvisionedProductProperties }}',
IdempotencyToken = '{{ IdempotencyToken }}'
WHERE 
region = '{{ region }}' --required
AND ProvisionedProductId = '{{ ProvisionedProductId }}' --required
AND ProvisionedProductProperties = '{{ ProvisionedProductProperties }}' --required
AND IdempotencyToken = '{{ IdempotencyToken }}' --required
RETURNING
provisioned_product_id,
provisioned_product_properties,
record_id,
status;

update_provisioned_product

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.

UPDATE aws.servicecatalog.provisioned_products
SET 
AcceptLanguage = '{{ AcceptLanguage }}',
ProvisionedProductName = '{{ ProvisionedProductName }}',
ProvisionedProductId = '{{ ProvisionedProductId }}',
ProductId = '{{ ProductId }}',
ProductName = '{{ ProductName }}',
ProvisioningArtifactId = '{{ ProvisioningArtifactId }}',
ProvisioningArtifactName = '{{ ProvisioningArtifactName }}',
PathId = '{{ PathId }}',
PathName = '{{ PathName }}',
ProvisioningParameters = '{{ ProvisioningParameters }}',
ProvisioningPreferences = '{{ ProvisioningPreferences }}',
Tags = '{{ Tags }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
record_detail;

DELETE examples

terminate_provisioned_product

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.

DELETE FROM aws.servicecatalog.provisioned_products
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

execute_provisioned_product_service_action

Executes a self-service action against a provisioned product.

EXEC aws.servicecatalog.provisioned_products.execute_provisioned_product_service_action 
@region='{{ region }}' --required 
@@json=
'{
"ProvisionedProductId": "{{ ProvisionedProductId }}", 
"ServiceActionId": "{{ ServiceActionId }}", 
"ExecuteToken": "{{ ExecuteToken }}", 
"AcceptLanguage": "{{ AcceptLanguage }}", 
"Parameters": "{{ Parameters }}"
}'
;

scan_provisioned_products

Lists the provisioned products that are available (not terminated). To use additional filtering, see SearchProvisionedProducts.

EXEC aws.servicecatalog.provisioned_products.scan_provisioned_products 
@region='{{ region }}' --required 
@@json=
'{
"AcceptLanguage": "{{ AcceptLanguage }}", 
"AccessLevelFilter": "{{ AccessLevelFilter }}", 
"PageSize": {{ PageSize }}, 
"PageToken": "{{ PageToken }}"
}'
;

search_provisioned_products

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

EXEC aws.servicecatalog.provisioned_products.search_provisioned_products 
@region='{{ region }}' --required 
@@json=
'{
"AcceptLanguage": "{{ AcceptLanguage }}", 
"AccessLevelFilter": "{{ AccessLevelFilter }}", 
"Filters": "{{ Filters }}", 
"SortBy": "{{ SortBy }}", 
"SortOrder": "{{ SortOrder }}", 
"PageSize": {{ PageSize }}, 
"PageToken": "{{ PageToken }}"
}'
;