resource_share_associations

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

Overview

Name	resource_share_associations
Type	Resource
Id	aws.ram.resource_share_associations

Fields

The following fields are returned by SELECT queries:

get_resource_share_associations

Name	Datatype	Description
associated_entity	string	The associated entity. This can be either of the following: For a resource association, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following: The ID of an Amazon Web Services account The Amazon Resource Name (ARN) of an organization in Organizations The ARN of an organizational unit (OU) in Organizations The ARN of an IAM role The ARN of an IAM user
association_type	string	The type of entity included in this association. (PRINCIPAL, RESOURCE, SOURCE)
creation_time	string (date-time)	The date and time when the association was created.
external	boolean	Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
last_updated_time	string (date-time)	The date and time when the association was last updated.
resource_share_arn	string	The Amazon Resource Name (ARN) of the resource share.
resource_share_name	string	The name of the resource share.
status	string	The current status of the association. (ASSOCIATING, ASSOCIATED, FAILED, DISASSOCIATING, DISASSOCIATED, SUSPENDED, SUSPENDING, RESTORING)
status_message	string	A message about the status of the association.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_share_associations	select	region		Retrieves the lists of resources and principals that associated for resource shares that you own. Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

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

get_resource_share_associations

Retrieves the lists of resources and principals that associated for resource shares that you own. Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

SELECT
associated_entity,
association_type,
creation_time,
external,
last_updated_time,
resource_share_arn,
resource_share_name,
status,
status_message
FROM aws.ram.resource_share_associations
WHERE region = '{{ region }}' -- required
;