listArtifacts method
Returns a list of artifacts for a specified app, branch, and job.
May throw BadRequestException. May throw UnauthorizedException. May throw InternalFailureException. May throw LimitExceededException.
Parameter appId
:
The unique ID for an Amplify app.
Parameter branchName
:
The name of a branch that is part of an Amplify app.
Parameter jobId
:
The unique ID for a job.
Parameter maxResults
:
The maximum number of records to list in a single response.
Parameter 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.
Implementation
Future<ListArtifactsResult> listArtifacts({
required String appId,
required String branchName,
required String jobId,
int? maxResults,
String? nextToken,
}) async {
ArgumentError.checkNotNull(appId, 'appId');
_s.validateStringLength(
'appId',
appId,
1,
20,
isRequired: true,
);
ArgumentError.checkNotNull(branchName, 'branchName');
_s.validateStringLength(
'branchName',
branchName,
1,
255,
isRequired: true,
);
ArgumentError.checkNotNull(jobId, 'jobId');
_s.validateStringLength(
'jobId',
jobId,
0,
255,
isRequired: true,
);
_s.validateNumRange(
'maxResults',
maxResults,
0,
100,
);
_s.validateStringLength(
'nextToken',
nextToken,
0,
2000,
);
final $query = <String, List<String>>{
if (maxResults != null) 'maxResults': [maxResults.toString()],
if (nextToken != null) 'nextToken': [nextToken],
};
final response = await _protocol.send(
payload: null,
method: 'GET',
requestUri:
'/apps/${Uri.encodeComponent(appId)}/branches/${Uri.encodeComponent(branchName)}/jobs/${Uri.encodeComponent(jobId)}/artifacts',
queryParams: $query,
exceptionFnMap: _exceptionFns,
);
return ListArtifactsResult.fromJson(response);
}