PartnerCentralSellingAPI / Paginator / ListResourceSnapshotJobs

ListResourceSnapshotJobs#

class PartnerCentralSellingAPI.Paginator.ListResourceSnapshotJobs#
paginator = client.get_paginator('list_resource_snapshot_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from PartnerCentralSellingAPI.Client.list_resource_snapshot_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    EngagementIdentifier='string',
    Sort={
        'SortBy': 'CreatedDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    Status='Running'|'Stopped',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog related to the request.

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

  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.