Skip to content

CreateResourceSnapshotRequest

Source code in docs_src/capo_partnercentral_selling/types/create_resource_snapshot_request.py
class CreateResourceSnapshotRequest(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p> Specifies the catalog where the snapshot is created. Valid values are <code>AWS</code> and <code>Sandbox</code>. </p>"""
    engagement_identifier: (
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    )
    """<p> The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context. </p>"""
    resource_type: "capo_partnercentral_selling.types.resource_type.ResourceType"
    """<p> Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: <code>Opportunity</code>. </p>"""
    resource_identifier: (
        "capo_partnercentral_selling.types.resource_identifier.ResourceIdentifier"
    )
    """<p> The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the <code>ResourceType</code> specified. For example: For <code>Opportunity</code> type, it will be an opportunity ID. </p>"""
    resource_snapshot_template_identifier: (
        "capo_partnercentral_selling.types.resource_template_name.ResourceTemplateName"
    )
    """<p> The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified <code>ResourceType</code>. </p>"""
    client_token: "capo_partnercentral_selling.types.client_token.ClientToken"
    """<p> Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations. </p>"""

catalog instance-attribute

Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

client_token instance-attribute

client_token: ClientToken

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

engagement_identifier instance-attribute

engagement_identifier: EngagementIdentifier

The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

resource_identifier instance-attribute

resource_identifier: ResourceIdentifier

The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.

resource_snapshot_template_identifier instance-attribute

resource_snapshot_template_identifier: ResourceTemplateName

The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

resource_type instance-attribute

resource_type: ResourceType

Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.