Skip to content

HandshakeResource

Source code in docs_src/capo_organizations/types/handshake_resource.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class HandshakeResource(TypedDict, closed=True):
    value: NotRequired[
        "capo_organizations.types.handshake_resource_value.HandshakeResourceValue"
    ]
    """<p>Additional information for the handshake. The format of the value string must match the requirements of the specified type.</p>"""
    type: NotRequired[
        "capo_organizations.types.handshake_resource_type.HandshakeResourceType"
    ]
    """<p>The type of information being passed, specifying how the value is to be interpreted by the other party:</p> <ul> <li> <p> <b>ACCOUNT</b>: ID for an Amazon Web Services account.</p> </li> <li> <p> <b>ORGANIZATION</b>: ID for an organization.</p> </li> <li> <p> <b>EMAIL</b>: Email address for the recipient.</p> </li> <li> <p> <b>OWNER_EMAIL</b>: Email address for the sender.</p> </li> <li> <p> <b>OWNER_NAME</b>: Name of the sender.</p> </li> <li> <p> <b>NOTES</b>: Additional text included by the sender for the recipient.</p> </li> </ul>"""
    resources: NotRequired[
        "capo_organizations.types.handshake_resources.HandshakeResources"
    ]
    """<p>An array of <code>HandshakeResource</code> objects. When needed, contains additional details for a handshake. For example, the email address for the sender.</p>"""

resources instance-attribute 

resources: NotRequired[HandshakeResources]

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

type instance-attribute 

type: NotRequired[HandshakeResourceType]

The type of information being passed, specifying how the value is to be interpreted by the other party:

  • 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.

value instance-attribute 

value: NotRequired[HandshakeResourceValue]

Additional information for the handshake. The format of the value string must match the requirements of the specified type.