AWS cli documentation change
Summary
Updated documentation for ListHandshakesForAccount API, including terminology clarifications, added TRANSFER_RESPONSIBILITY action type, improved NextToken guidance, and restructured handshake state/resource descriptions
Security assessment
Changes focus on improving documentation clarity and adding new handshake type (TRANSFER_RESPONSIBILITY). While TRANSFER_RESPONSIBILITY relates to account management responsibilities, the documentation update itself doesn't address a specific security vulnerability or weakness. The changes enhance operational understanding but don't directly mitigate or document security risks.
Diff
diff --git a/cli/latest/reference/organizations/list-handshakes-for-account.md b/cli/latest/reference/organizations/list-handshakes-for-account.md index eaeab00ff..4ce8c6952 100644 --- a//cli/latest/reference/organizations/list-handshakes-for-account.md +++ b//cli/latest/reference/organizations/list-handshakes-for-account.md @@ -15 +15 @@ - * [AWS CLI 2.31.39 Command Reference](../../index.html) » + * [AWS CLI 2.32.3 Command Reference](../../index.html) » @@ -60 +60 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Lists the current handshakes that are associated with the account of the requesting user. +Lists the recent handshakes that you have received. @@ -62 +62 @@ Lists the current handshakes that are associated with the account of the request -Handshakes that are `ACCEPTED` , `DECLINED` , `CANCELED` , or `EXPIRED` appear in the results of this API for only 30 days after changing to that state. After that, they’re deleted and no longer accessible. +You can view `CANCELED` , `ACCEPTED` , `DECLINED` , or `EXPIRED` handshakes in API responses for 30 days before they are deleted. @@ -64 +64 @@ Handshakes that are `ACCEPTED` , `DECLINED` , `CANCELED` , or `EXPIRED` appear i -### Note +You can call this operation from any account in a organization. @@ -66 +66 @@ Handshakes that are `ACCEPTED` , `DECLINED` , `CANCELED` , or `EXPIRED` appear i -Always check the `NextToken` response parameter for a `null` value when calling a `List*` 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. +### Note @@ -68 +68 @@ Always check the `NextToken` response parameter for a `null` value when calling -This operation can be called from any account in the organization. +When calling List* operations, always check the `NextToken` response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until `NextToken` returns null. A null `NextToken` value indicates that you have retrieved all available results. @@ -108 +108 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/organi -> Filters 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 `ParentHandshakeId` to see only the handshakes that were generated by that parent request. +> A `HandshakeFilter` object. Contains the filer used to select the handshakes for an operation. @@ -112 +112 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/organi ->> Specifies the type of handshake action. +>> The type of handshake. @@ -121,0 +122 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/organi +>> * `TRANSFER_RESPONSIBILITY` @@ -127 +128 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/organi ->> Specifies the parent handshake. Only used for handshake types that are a child of another type. +>> The parent handshake. Only used for handshake types that are a child of another type. @@ -150 +151 @@ JSON Syntax: - "ActionType": "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE", + "ActionType": "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE"|"TRANSFER_RESPONSIBILITY", @@ -339 +340 @@ Handshakes -> (list) -> A list of Handshake objects with details about each of the handshakes that is associated with the specified account. +> An array of `Handshake` objects. Contains details for a handshake. @@ -343 +344 @@ Handshakes -> (list) ->> Contains information that must be exchanged to securely establish a relationship between two accounts (an _originator_ and a _recipient_ ). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses. +>> Contains details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient. @@ -349 +350 @@ Handshakes -> (list) ->>> The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake. +>>> ID for the handshake. @@ -362 +363 @@ Handshakes -> (list) ->>> The Amazon Resource Name (ARN) of a handshake. +>>> Amazon Resource Name (ARN) for the handshake. @@ -374 +375 @@ Handshakes -> (list) ->>> Information about the two accounts that are participating in the handshake. +>>> An array of `HandshakeParty` objects. Contains details for participant in a handshake. @@ -378 +379 @@ Handshakes -> (list) ->>>> Identifies a participant in a handshake. +>>>> Contains details for a participant in a handshake. @@ -382 +383 @@ Handshakes -> (list) ->>>>> The unique identifier (ID) for the party. +>>>>> ID for the participant: Acccount ID, organization ID, or email address. @@ -396 +397 @@ Handshakes -> (list) ->>>>> The type of party. +>>>>> The type of ID for the participant. @@ -408 +409 @@ Handshakes -> (list) ->>> 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: +>>> Current state for the handshake. @@ -410,6 +411,6 @@ Handshakes -> (list) ->>> * **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). +>>> * **REQUESTED** : Handshake awaiting a response from the recipient. +>>> * **OPEN** : Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action. +>>> * **CANCELED** : Handshake canceled by the sender. +>>> * **ACCEPTED** : Handshake accepted by the recipient. +>>> * **DECLINED** : Handshake declined by the recipient. +>>> * **EXPIRED** : Handshake has expired. @@ -432 +433 @@ Handshakes -> (list) ->>> The date and time that the handshake request was made. +>>> Timestamp when the handshake request was made. @@ -436 +437 @@ Handshakes -> (list) ->>> 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 when the handshake expires. @@ -440 +441 @@ Handshakes -> (list) ->>> The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported: +>>> The type of handshake: @@ -442,3 +443,4 @@ Handshakes -> (list) ->>> * **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. +>>> * **INVITE** : Handshake sent to a standalone account requesting that it to join the sender’s organization. +>>> * **ENABLE_ALL_FEATURES** : Handshake sent to invited member accounts to enable all features for the organization. +>>> * **APPROVE_ALL_FEATURES** : Handshake sent to the management account when all invited member accounts have approved to enable all features. +>>> * **TRANSFER_RESPONSIBILITY** : Handshake sent to another organization’s management account requesting that it designate the sender with the specified responsibilities for recipient’s organization. @@ -453,0 +456 @@ Handshakes -> (list) +>>> * `TRANSFER_RESPONSIBILITY` @@ -459 +462 @@ Handshakes -> (list) ->>> Additional information that is needed to process the handshake. +>>> An array of `HandshakeResource` objects. When needed, contains additional details for a handshake. For example, the email address for the sender. @@ -463 +466 @@ Handshakes -> (list) ->>>> Contains additional data that is needed to process a handshake. +>>>> Contains additional details for a handshake. @@ -467 +470 @@ Handshakes -> (list) ->>>>> 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. +>>>>> Additional information for the handshake. The format of the value string must match the requirements of the specified type. @@ -473,6 +476,6 @@ Handshakes -> (list) ->>>>> * `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. +>>>>> * **ACCOUNT** : ID for an Amazon Web Services account. +>>>>> * **ORGANIZATION** : ID for an organization. +>>>>> * **EMAIL** : Email address for the recipient. +>>>>> * **OWNER_EMAIL** : Email address for the sender. +>>>>> * **OWNER_NAME** : Name of the sender. +>>>>> * **NOTES** : Additional text included by the sender for the recipient. @@ -491,0 +495,6 @@ Handshakes -> (list) +>>>>> * `RESPONSIBILITY_TRANSFER` +>>>>> * `TRANSFER_START_TIMESTAMP` +>>>>> * `TRANSFER_TYPE` +>>>>> * `MANAGEMENT_ACCOUNT` +>>>>> * `MANAGEMENT_EMAIL` +>>>>> * `MANAGEMENT_NAME` @@ -497 +506 @@ Handshakes -> (list) ->>>>> When needed, contains an additional array of `HandshakeResource` objects. +>>>>> An array of `HandshakeResource` objects. When needed, contains additional details for a handshake. For example, the email address for the sender. @@ -501 +510 @@ Handshakes -> (list) ->>>>>> Contains additional data that is needed to process a handshake. +>>>>>> Contains additional details for a handshake. @@ -505 +514 @@ Handshakes -> (list) ->>>>>>> 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. +>>>>>>> Additional information for the handshake. The format of the value string must match the requirements of the specified type. @@ -511,6 +520,6 @@ Handshakes -> (list) ->>>>>>> * `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. +>>>>>>> * **ACCOUNT** : ID for an Amazon Web Services account. +>>>>>>> * **ORGANIZATION** : ID for an organization. +>>>>>>> * **EMAIL** : Email address for the recipient. +>>>>>>> * **OWNER_EMAIL** : Email address for the sender. +>>>>>>> * **OWNER_NAME** : Name of the sender. +>>>>>>> * **NOTES** : Additional text included by the sender for the recipient. @@ -529,0 +539,6 @@ Handshakes -> (list) +>>>>>>> * `RESPONSIBILITY_TRANSFER` +>>>>>>> * `TRANSFER_START_TIMESTAMP` +>>>>>>> * `TRANSFER_TYPE` +>>>>>>> * `MANAGEMENT_ACCOUNT` +>>>>>>> * `MANAGEMENT_EMAIL` +>>>>>>> * `MANAGEMENT_NAME` @@ -554 +569 @@ NextToken -> (string) - * [AWS CLI 2.31.39 Command Reference](../../index.html) » + * [AWS CLI 2.32.3 Command Reference](../../index.html) »