PartnerCentralSellingAPI / Client / create_resource_snapshot_job

create_resource_snapshot_job#

PartnerCentralSellingAPI.Client.create_resource_snapshot_job(**kwargs)#

Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

See also: AWS API Documentation

Request Syntax

response = client.create_resource_snapshot_job(
    Catalog='string',
    ClientToken='string',
    EngagementIdentifier='string',
    ResourceIdentifier='string',
    ResourceSnapshotTemplateIdentifier='string',
    ResourceType='Opportunity',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    [REQUIRED]

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

    This field is autopopulated if not provided.

  • EngagementIdentifier (string) –

    [REQUIRED]

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

  • ResourceIdentifier (string) –

    [REQUIRED]

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

  • ResourceSnapshotTemplateIdentifier (string) –

    [REQUIRED]

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

  • ResourceType (string) –

    [REQUIRED]

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

  • Tags (list) –

    A list of objects specifying each tag name and value.

    • (dict) –

      The key-value pair assigned to a specified resource.

      • Key (string) – [REQUIRED]

        The key in the tag.

      • Value (string) – [REQUIRED]

        The value in the tag.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the created snapshot job.

    • Id (string) –

      The unique identifier for the created snapshot job.

Exceptions