ListArtifacts - AWS Amplify

ListArtifacts

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

Request Syntax

GET /apps/appId/branches/branchName/jobs/jobId/artifacts?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

branchName

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

jobId

The unique ID for a job.

Length Constraints: Maximum length of 255.

Required: Yes

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

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.

Length Constraints: Maximum length of 2000.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "artifacts": [ { "artifactFileName": "string", "artifactId": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

artifacts

A list of artifacts.

Type: Array of Artifact objects

nextToken

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

Type: String

Length Constraints: Maximum length of 2000.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

LimitExceededException

A resource could not be created because service quotas were exceeded.

HTTP Status Code: 429

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: