portfolio_share_status

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

Overview

Name	portfolio_share_status
Type	Resource
Id	aws.servicecatalog.portfolio_share_status

Fields

The following fields are returned by SELECT queries:

describe_portfolio_share_status

Name	Datatype	Description
organization_node_value	string	Organization node identifier. It can be either account id, organizational unit id or organization id. (pattern: <code>(^[0-9]{12}$)|(^arn:aws:organizations::\d{12}:organization/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\d{12}:ou/o-[a-z0-9]{10,32}/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)</code>)
portfolio_id	string	The portfolio identifier. (pattern: <code>^[a-zA-Z0-9_-]*</code>)
portfolio_share_token	string	The token for the portfolio share operation. For example, share-6v24abcdefghi. (pattern: <code>^[a-zA-Z0-9_-]*</code>)
share_details	object	Information about the portfolio share operation.
status	string	Status of the portfolio share operation. (NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, ERROR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_portfolio_share_status	select	region		Gets 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.

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_portfolio_share_status

Gets 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.

SELECT
organization_node_value,
portfolio_id,
portfolio_share_token,
share_details,
status
FROM aws.servicecatalog.portfolio_share_status
WHERE region = '{{ region }}' -- required
;