ChannelHandshakeSummary
Summary information about a channel handshake.
Contents
Note
In the following list, the required parameters are described first.
- arn
-
The Amazon Resource Name (ARN) of the handshake.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: No
- associatedResourceId
-
The identifier of the resource associated with the handshake.
Type: String
Length Constraints: Minimum length of 16. Maximum length of 17.
Pattern:
(pma|rs)-[a-z0-9]{13}Required: No
- catalog
-
The catalog identifier associated with the handshake.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z]*Required: No
- createdAt
-
The timestamp when the handshake was created.
Type: Timestamp
Required: No
- detail
-
Detailed information about the handshake.
Type: HandshakeDetail object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- handshakeType
-
The type of the handshake.
Type: String
Valid Values:
START_SERVICE_PERIOD | REVOKE_SERVICE_PERIOD | PROGRAM_MANAGEMENT_ACCOUNTRequired: No
- id
-
The unique identifier of the handshake.
Type: String
Length Constraints: Fixed length of 16.
Pattern:
ch-[a-z0-9]{13}Required: No
- ownerAccountId
-
The AWS account ID of the handshake owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]*Required: No
- receiverAccountId
-
The AWS account ID of the handshake receiver.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]*Required: No
- senderAccountId
-
The AWS account ID of the handshake sender.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
[0-9]*Required: No
- senderDisplayName
-
The display name of the handshake sender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[\x00-\x7E\xA9\xAE\xA2-\xA5\u202F]+Required: No
- status
-
The current status of the handshake.
Type: String
Valid Values:
PENDING | ACCEPTED | REJECTED | CANCELED | EXPIREDRequired: No
- updatedAt
-
The timestamp when the handshake was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
