Skip to content

CreateResourceSnapshotJobRequest

Source code in docs_src/capo_partnercentral_selling/types/create_resource_snapshot_job_request.py
class CreateResourceSnapshotJobRequest(TypedDict, closed=True):
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier"
    """<p>Specifies the catalog in which to create the snapshot job. Valid values are <code>AWS</code> and <code> Sandbox</code>.</p>"""
    client_token: "capo_partnercentral_selling.types.client_token.ClientToken"
    """<p>A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.</p>"""
    engagement_identifier: (
        "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier"
    )
    """<p>Specifies the identifier of the engagement associated with the resource to be snapshotted.</p>"""
    resource_type: "capo_partnercentral_selling.types.resource_type.ResourceType"
    """<p>The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. <code>Opportunity</code> </p>"""
    resource_identifier: (
        "capo_partnercentral_selling.types.resource_identifier.ResourceIdentifier"
    )
    """<p>Specifies the identifier of the specific resource to be snapshotted. The format depends on the <code> ResourceType</code>.</p>"""
    resource_snapshot_template_identifier: (
        "capo_partnercentral_selling.types.resource_template_name.ResourceTemplateName"
    )
    """<p>Specifies the name of the template that defines the schema for the snapshot.</p>"""
    tags: NotRequired["capo_partnercentral_selling.types.tag_list.TagList"]
    """<p>A map of the key-value pairs of the tag or tags to assign.</p>"""

catalog instance-attribute

Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

client_token instance-attribute

client_token: ClientToken

A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

engagement_identifier instance-attribute

engagement_identifier: EngagementIdentifier

Specifies the identifier of the engagement associated with the resource to be snapshotted.

resource_identifier instance-attribute

resource_identifier: ResourceIdentifier

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

resource_snapshot_template_identifier instance-attribute

resource_snapshot_template_identifier: ResourceTemplateName

Specifies the name of the template that defines the schema for the snapshot.

resource_type instance-attribute

resource_type: ResourceType

The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

tags instance-attribute

tags: NotRequired[TagList]

A map of the key-value pairs of the tag or tags to assign.