Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_artifacts

list_artifacts(**kwargs)

Returns a list of artifacts for a specified app, branch, and job.

See also: AWS API Documentation

Request Syntax

response = client.list_artifacts(
    appId='string',
    branchName='string',
    jobId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • appId (string) --

    [REQUIRED]

    The unique ID for an Amplify app.

  • branchName (string) --

    [REQUIRED]

    The name of a branch that is part of an Amplify app.

  • jobId (string) --

    [REQUIRED]

    The unique ID for a job.

  • nextToken (string) -- A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
  • maxResults (integer) -- The maximum number of records to list in a single response.
Return type

dict

Returns

Response Syntax

{
    'artifacts': [
        {
            'artifactFileName': 'string',
            'artifactId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The result structure for the list artifacts request.

    • artifacts (list) --

      A list of artifacts.

      • (dict) --

        Describes an artifact.

        • artifactFileName (string) --

          The file name for the artifact.

        • artifactId (string) --

          The unique ID for the artifact.

    • nextToken (string) --

      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

Exceptions

  • Amplify.Client.exceptions.BadRequestException
  • Amplify.Client.exceptions.UnauthorizedException
  • Amplify.Client.exceptions.InternalFailureException
  • Amplify.Client.exceptions.LimitExceededException