artifacts

Creates, updates, deletes, gets or lists an artifacts resource.

Overview

Name	artifacts
Type	Resource
Id	aws.amplify.artifacts

Fields

The following fields are returned by SELECT queries:

list_artifacts

Name	Datatype	Description
artifacts	array	A list of artifacts.
next_token	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. (pattern: <code>(?s).*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_artifacts	select	app_id, branch_name, job_id, region	nextToken, maxResults	Returns a list of end-to-end testing artifacts for a specified app, branch, and job. To return the build artifacts, use the GetJob API. For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app_id	string	The unique ID for an Amplify app.
branch_name	string	The name of a branch that is part of an Amplify app.
job_id	string	The unique ID for a job.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of records to list in a single response.
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.

SELECT examples

list_artifacts

Returns a list of end-to-end testing artifacts for a specified app, branch, and job. To return the build artifacts, use the GetJob API. For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide.

SELECT
artifacts,
next_token
FROM aws.amplify.artifacts
WHERE app_id = '{{ app_id }}' -- required
AND branch_name = '{{ branch_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;