Skip to content
AWS for Query.Farm

aws.ram.get_resource_share_invitations

Example SQL Queries

SELECT * FROM
aws.ram.get_resource_share_invitations;

Description

Retrieves details about invitations that you have received for resource shares.

Table Definition

Column NameColumn Data Type
resource_share_arns Input Column

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs) 

VARCHAR[]
Show child fields
resource_share_arns[]
resource_share_invitation_arns Input Column

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

VARCHAR[]
Show child fields
resource_share_invitation_arns[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
invitation_timestamp

The date and time when the invitation was sent.

TIMESTAMP_S
receiver_account_id

The ID of the Amazon Web Services account that received the invitation.

VARCHAR
receiver_arn

The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.

VARCHAR
resource_share_arn

The Amazon Resource Name (ARN) of the resource share

VARCHAR
resource_share_associations

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

STRUCT(
    "resource_share_arn" VARCHAR,
    "resource_share_name" VARCHAR,
    "associated_entity" VARCHAR,
    "association_type" VARCHAR,
    "status" VARCHAR,
    "status_message" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "external" BOOLEAN
)[]
Show child fields
resource_share_associations[]
Show child fields
resource_share_associations[].associated_entity

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

resource_share_associations[].association_type

The type of entity included in this association.

resource_share_associations[].creation_time

The date and time when the association was created.

resource_share_associations[].external

Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

resource_share_associations[].last_updated_time

The date and time when the association was last updated.

resource_share_associations[].resource_share_arn

The Amazon Resource Name (ARN) of the resource share.

resource_share_associations[].resource_share_name

The name of the resource share.

resource_share_associations[].status

The current status of the association.

resource_share_associations[].status_message

A message about the status of the association.

resource_share_invitation_arn

The Amazon Resource Name (ARN) of the invitation.

VARCHAR
resource_share_name

The name of the resource share.

VARCHAR
sender_account_id

The ID of the Amazon Web Services account that sent the invitation.

VARCHAR
status

The current status of the invitation.

VARCHAR