PartnerCentralSellingAPI / Client / get_resource_snapshot_job

get_resource_snapshot_job¶

PartnerCentralSellingAPI.Client.get_resource_snapshot_job(**kwargs)¶

Use this action to retrieves information about a specific resource snapshot job.

Request Syntax

response = client.get_resource_snapshot_job(
    Catalog='string',
    ResourceSnapshotJobIdentifier='string'
)

Parameters:

Catalog (string) –
[REQUIRED]

Specifies the catalog related to the request. Valid values are:
- AWS: Retrieves the snapshot job from the production AWS environment.
- Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes.
ResourceSnapshotJobIdentifier (string) –
[REQUIRED]

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

Return type:

dict

Returns:

Response Syntax

{
    'Catalog': 'string',
    'Id': 'string',
    'Arn': 'string',
    'EngagementId': 'string',
    'ResourceType': 'Opportunity',
    'ResourceId': 'string',
    'ResourceArn': 'string',
    'ResourceSnapshotTemplateName': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Status': 'Running'|'Stopped',
    'LastSuccessfulExecutionDate': datetime(2015, 1, 1),
    'LastFailure': 'string'
}

Response Structure

(dict) –
- Catalog (string) –
  
  The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
- Id (string) –
  
  The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
- EngagementId (string) –
  
  The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.
- ResourceType (string) –
  
  The type of resource being snapshotted. This would have “Opportunity” as a value as it is dependent on the supported resource type.
- ResourceId (string) –
  
  The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
- ResourceArn (string) –
  
  The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
- ResourceSnapshotTemplateName (string) –
  
  The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.
- CreatedAt (datetime) –
  
  The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”
- Status (string) –
  
  The current status of the snapshot job. Valid values:
  - STOPPED: The job is not currently running.
  - RUNNING: The job is actively executing.
- LastSuccessfulExecutionDate (datetime) –
  
  The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: “2023-05-01T20:37:46Z”
- LastFailure (string) –
  
  If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

Exceptions

PartnerCentralSellingAPI.Client.exceptions.ThrottlingException
PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException
PartnerCentralSellingAPI.Client.exceptions.ValidationException
PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException