ListArtifacts
Lists the artifacts in your account and their properties.
Request Syntax
{
"ArtifactType": "string
",
"CreatedAfter": number
,
"CreatedBefore": number
,
"MaxResults": number
,
"NextToken": "string
",
"SortBy": "string
",
"SortOrder": "string
",
"SourceUri": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ArtifactType
-
A filter that returns only artifacts of the specified type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
- CreatedAfter
-
A filter that returns only artifacts created on or after the specified time.
Type: Timestamp
Required: No
- CreatedBefore
-
A filter that returns only artifacts created on or before the specified time.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of artifacts to return in the response. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the previous call to
ListArtifacts
didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- SortBy
-
The property used to sort results. The default value is
CreationTime
.Type: String
Valid Values:
CreationTime
Required: No
- SortOrder
-
The sort order. The default value is
Descending
.Type: String
Valid Values:
Ascending | Descending
Required: No
- SourceUri
-
A filter that returns only artifacts with the specified source URI.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
.*
Required: No
Response Syntax
{
"ArtifactSummaries": [
{
"ArtifactArn": "string",
"ArtifactName": "string",
"ArtifactType": "string",
"CreationTime": number,
"LastModifiedTime": number,
"Source": {
"SourceTypes": [
{
"SourceIdType": "string",
"Value": "string"
}
],
"SourceUri": "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.
- ArtifactSummaries
-
A list of artifacts and their properties.
Type: Array of ArtifactSummary objects
- NextToken
-
A token for getting the next set of artifacts, if there are any.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: