Skip to content

CreateChannelHandshakeRequest

Source code in docs_src/capo_partnercentral_channel/types/create_channel_handshake_request.py
class CreateChannelHandshakeRequest(TypedDict, closed=True):
    handshake_type: "capo_partnercentral_channel.types.handshake_type.HandshakeType"
    """<p>The type of handshake to create (e.g., start service period, revoke service period).</p>"""
    catalog: "capo_partnercentral_channel.types.catalog.Catalog"
    """<p>The catalog identifier for the handshake request.</p>"""
    associated_resource_identifier: "capo_partnercentral_channel.types.associated_resource_identifier.AssociatedResourceIdentifier"
    """<p>The identifier of the resource associated with this handshake.</p>"""
    payload: NotRequired[
        "capo_partnercentral_channel.types.channel_handshake_payload.ChannelHandshakePayload"
    ]
    """<p>The payload containing specific details for the handshake type.</p>"""
    client_token: NotRequired[
        "capo_partnercentral_channel.types.client_token.ClientToken"
    ]
    """<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>"""
    tags: NotRequired["capo_partnercentral_channel.types.tag_list.TagList"]
    """<p>Key-value pairs to associate with the channel handshake.</p>"""

associated_resource_identifier instance-attribute

associated_resource_identifier: AssociatedResourceIdentifier

The identifier of the resource associated with this handshake.

catalog instance-attribute

catalog: Catalog

The catalog identifier for the handshake request.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier to ensure idempotency of the request.

handshake_type instance-attribute

handshake_type: HandshakeType

The type of handshake to create (e.g., start service period, revoke service period).

payload instance-attribute

payload: NotRequired[ChannelHandshakePayload]

The payload containing specific details for the handshake type.

tags instance-attribute

tags: NotRequired[TagList]

Key-value pairs to associate with the channel handshake.