DevOpsAgentService / Client / list_asset_files

list_asset_files

DevOpsAgentService.Client.list_asset_files(**kwargs)

Lists files in an asset

See also: AWS API Documentation

Request Syntax

response = client.list_asset_files(
    agentSpaceId='string',
    assetId='string',
    assetVersion=123,
    nextToken='string',
    maxResults=123
)
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.

  • nextToken (string) – Pagination token from a previous response to retrieve the next page of results

  • maxResults (integer) – The maximum number of results to return in a single 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) –

      Pagination token to retrieve the next page of results. Absent when there are no more results.

Exceptions

  • DevOpsAgentService.Client.exceptions.ValidationException

  • DevOpsAgentService.Client.exceptions.ContentSizeExceededException

  • DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException

  • DevOpsAgentService.Client.exceptions.ConflictException

  • DevOpsAgentService.Client.exceptions.InternalServerException

  • DevOpsAgentService.Client.exceptions.AccessDeniedException

  • DevOpsAgentService.Client.exceptions.ResourceNotFoundException

  • DevOpsAgentService.Client.exceptions.ThrottlingException

  • DevOpsAgentService.Client.exceptions.InvalidParameterException