:doc:`Amplify <../../amplify>` / Client / list_artifacts

**************
list_artifacts
**************



.. py:method:: Amplify.Client.list_artifacts(**kwargs)

  

  Returns a list of end-to-end testing artifacts for a specified app, branch, and job.

   

  To return the build artifacts, use the `GetJob <https://docs.aws.amazon.com/amplify/latest/APIReference/API_GetJob.html>`__ API.

   

  For more information about Amplify testing support, see `Setting up end-to-end Cypress tests for your Amplify application <https://docs.aws.amazon.com/amplify/latest/userguide/running-tests.html>`__ in the *Amplify Hosting User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListArtifacts>`_  


  **Request Syntax**
  ::

    response = client.list_artifacts(
        appId='string',
        branchName='string',
        jobId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique ID for an Amplify app.

    

  
  :type branchName: string
  :param branchName: **[REQUIRED]** 

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

    

  
  :type jobId: string
  :param jobId: **[REQUIRED]** 

    The unique ID for a job.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of records to list in a single response.

    

  
  
  :rtype: 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**
  
  *   :py:class:`Amplify.Client.exceptions.BadRequestException`

  
  *   :py:class:`Amplify.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`Amplify.Client.exceptions.InternalFailureException`

  
  *   :py:class:`Amplify.Client.exceptions.LimitExceededException`

  