records

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

Overview

Name	records
Type	Resource
Id	aws.servicecatalog.records

Fields

The following fields are returned by SELECT queries:

describe_record

Name	Datatype	Description
next_page_token	string	The page token to use to retrieve the next set of results. If there are no additional results, this value is null. (pattern: <code>[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*</code>)
record_detail	object	Information about the product.
record_outputs	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_record	select	region		Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). 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.
notify_provision_product_engine_workflow_result	exec	region, WorkflowToken, RecordId, Status, IdempotencyToken		Notifies the result of the provisioning engine execution.
notify_terminate_provisioned_product_engine_workflow_result	exec	region, WorkflowToken, RecordId, Status, IdempotencyToken		Notifies the result of the terminate engine execution.
notify_update_provisioned_product_engine_workflow_result	exec	region, WorkflowToken, RecordId, Status, IdempotencyToken		Notifies the result of the update engine execution.

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_record

Gets information about the specified request operation. Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct). 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.

SELECT
next_page_token,
record_detail,
record_outputs
FROM aws.servicecatalog.records
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

notify_provision_product_engine_workflow_result

Notifies the result of the provisioning engine execution.

EXEC aws.servicecatalog.records.notify_provision_product_engine_workflow_result 
@region='{{ region }}' --required 
@@json=
'{
"WorkflowToken": "{{ WorkflowToken }}", 
"RecordId": "{{ RecordId }}", 
"Status": "{{ Status }}", 
"FailureReason": "{{ FailureReason }}", 
"ResourceIdentifier": "{{ ResourceIdentifier }}", 
"Outputs": "{{ Outputs }}", 
"IdempotencyToken": "{{ IdempotencyToken }}"
}'
;

notify_terminate_provisioned_product_engine_workflow_result

Notifies the result of the terminate engine execution.

EXEC aws.servicecatalog.records.notify_terminate_provisioned_product_engine_workflow_result 
@region='{{ region }}' --required 
@@json=
'{
"WorkflowToken": "{{ WorkflowToken }}", 
"RecordId": "{{ RecordId }}", 
"Status": "{{ Status }}", 
"FailureReason": "{{ FailureReason }}", 
"IdempotencyToken": "{{ IdempotencyToken }}"
}'
;

notify_update_provisioned_product_engine_workflow_result

Notifies the result of the update engine execution.

EXEC aws.servicecatalog.records.notify_update_provisioned_product_engine_workflow_result 
@region='{{ region }}' --required 
@@json=
'{
"WorkflowToken": "{{ WorkflowToken }}", 
"RecordId": "{{ RecordId }}", 
"Status": "{{ Status }}", 
"FailureReason": "{{ FailureReason }}", 
"Outputs": "{{ Outputs }}", 
"IdempotencyToken": "{{ IdempotencyToken }}"
}'
;