| Column Name | Column Data Type |
|---|
filter Input Column
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request. | STRUCT(
"action_type" VARCHAR,
"parent_handshake_id" VARCHAR
) |
Show child fields- filter.action_type
Specifies the type of handshake action. If you specify ActionType, you cannot also specify ParentHandshakeId. - filter.parent_handshake_id
Specifies the parent handshake. Only used for handshake types that are a child of another type. If you specify ParentHandshakeId, you cannot also specify ActionType. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.
|
_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.
|
action
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported: -
INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts. -
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred. -
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features. | VARCHAR |
arn
The Amazon Resource Name (ARN) of a handshake. For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference. | VARCHAR |
expiration_timestamp
The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid. | TIMESTAMP_S |
id
The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. | VARCHAR |
parties
Information about the two accounts that are participating in the handshake. | STRUCT(
"id" VARCHAR,
"type" VARCHAR
)[] |
Show child fields- parties[]
Show child fields- parties[].id
The unique identifier (ID) for the party. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits. - parties[].type
The type of party.
|
requested_timestamp
The date and time that the handshake request was made. | TIMESTAMP_S |
resources
Additional information that is needed to process the handshake. | STRUCT(
"value" VARCHAR,
"type" VARCHAR
)[] |
Show child fields- resources[]
Show child fields- resources[].type
The type of information being passed, specifying how the value is to be interpreted by the other party: -
ACCOUNT - Specifies an Amazon Web Services account ID number. -
ORGANIZATION - Specifies an organization ID number. -
EMAIL - Specifies the email address that is associated with the account that receives the handshake. -
OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization. -
OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization. -
NOTES - Additional text provided by the handshake initiator and intended for the recipient to read. - resources[].value
The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
|
state
The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows: -
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond. -
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action. -
CANCELED: This handshake is no longer active because it was canceled by the originating account. -
ACCEPTED: This handshake is complete because it has been accepted by the recipient. -
DECLINED: This handshake is no longer active because it was declined by the recipient account. -
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days). | VARCHAR |