Skip to main content

resource_share_invitations

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

Overview

Nameresource_share_invitations
TypeResource
Idaws.ram.resource_share_invitations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
invitation_timestampstring (date-time)The date and time when the invitation was sent.
receiver_account_idstringThe ID of the Amazon Web Services account that received the invitation.
receiver_arnstringThe Amazon Resource Name (ARN) of the IAM user or role that received the invitation.
resource_share_arnstringThe Amazon Resource Name (ARN) of the resource share
resource_share_associationsarrayTo view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
resource_share_invitation_arnstringThe Amazon Resource Name (ARN) of the invitation.
resource_share_namestringThe name of the resource share.
sender_account_idstringThe ID of the Amazon Web Services account that sent the invitation.
statusstringThe current status of the invitation. (PENDING, ACCEPTED, REJECTED, EXPIRED)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_resource_share_invitationsselectregionRetrieves details about invitations that you have received for resource shares. 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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves details about invitations that you have received for resource shares. 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
invitation_timestamp,
receiver_account_id,
receiver_arn,
resource_share_arn,
resource_share_associations,
resource_share_invitation_arn,
resource_share_name,
sender_account_id,
status
FROM aws.ram.resource_share_invitations
WHERE region = '{{ region }}' -- required
;