PartnerCentralSellingAPI / Client / list_resource_snapshot_jobs

list_resource_snapshot_jobs#

PartnerCentralSellingAPI.Client.list_resource_snapshot_jobs(**kwargs)#

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_snapshot_jobs(
    Catalog='string',
    EngagementIdentifier='string',
    MaxResults=123,
    NextToken='string',
    Sort={
        'SortBy': 'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    Status='Running'|'Stopped'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog related to the request.

  • EngagementIdentifier (string) – The identifier of the engagement to filter the response.

  • MaxResults (integer) – The maximum number of results to return in a single call. If omitted, defaults to 50.

  • NextToken (string) – The token for the next set of results.

  • Sort (dict) –

    Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

    • SortBy (string) –

      Specifies the field by which to sort the resource snapshot jobs.

    • SortOrder (string) –

      Determines the order in which the sorted results are presented.

  • Status (string) – The status of the jobs to filter the response.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ResourceSnapshotJobSummaries': [
        {
            'Arn': 'string',
            'EngagementId': 'string',
            'Id': 'string',
            'Status': 'Running'|'Stopped'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The token to retrieve the next set of results. If there are no additional results, this value is null.

    • ResourceSnapshotJobSummaries (list) –

      An array of resource snapshot job summary objects.

      • (dict) –

        An object that contains a Resource Snapshot Job’s subset of fields.

        • Arn (string) –

          The Amazon Resource Name (ARN) for the resource snapshot job.

        • EngagementId (string) –

          The unique identifier of the Engagement.

        • Id (string) –

          The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.

        • Status (string) –

          The current status of the snapshot job.

          Valid values:

          • STOPPED: The job is not currently running.

          • RUNNING: The job is actively executing.

Exceptions

  • PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

  • PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

  • PartnerCentralSellingAPI.Client.exceptions.ValidationException

  • PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException