DevOpsAgentService / Paginator / ListAssetFiles

ListAssetFiles

class DevOpsAgentService.Paginator.ListAssetFiles

paginator = client.get_paginator('list_asset_files')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_asset_files().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    assetId='string',
    assetVersion=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier for the agent space containing the asset

• assetId (string) –

  [REQUIRED]

  The unique identifier of the asset whose files to list

• assetVersion (integer) – The specific asset version to list files from. If omitted, files from the latest version are returned.

• 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

{
    'items': [
        {
            'path': 'string',
            'metadata': {...}|[...]|123|123.4|'string'|True|None,
            'version': 123,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for listing asset files

  • items (list) –

    The list of asset file summaries

    • (dict) –

      Summary of a file within an asset, including its path, version, and timestamps.

      • path (string) –

        The path of this file within the asset

      • metadata (document) –

        The metadata for this file

      • version (integer) –

        The asset version this file belongs to

      • createdAt (datetime) –

        Timestamp when this file was created

      • updatedAt (datetime) –

        Timestamp when this file was last updated

  • NextToken (string) –

    A token to resume pagination.