resource_share_invitations
Creates, updates, deletes, gets or lists a resource_share_invitations resource.
Overview
| Name | resource_share_invitations |
| Type | Resource |
| Id | aws.ram.resource_share_invitations |
Fields
The following fields are returned by SELECT queries:
- get_resource_share_invitations
| Name | Datatype | Description |
|---|---|---|
invitation_timestamp | string (date-time) | The date and time when the invitation was sent. |
receiver_account_id | string | The ID of the Amazon Web Services account that received the invitation. |
receiver_arn | string | The Amazon Resource Name (ARN) of the IAM user or role that received the invitation. |
resource_share_arn | string | The Amazon Resource Name (ARN) of the resource share |
resource_share_associations | array | To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources. |
resource_share_invitation_arn | string | The Amazon Resource Name (ARN) of the invitation. |
resource_share_name | string | The name of the resource share. |
sender_account_id | string | The ID of the Amazon Web Services account that sent the invitation. |
status | string | The current status of the invitation. (PENDING, ACCEPTED, REJECTED, EXPIRED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_resource_share_invitations | select | region | 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. |
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_invitations
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
;