GetReferenceMetadata
Gets information about a genome reference's metadata.
Request Syntax
GET /referencestore/referenceStoreId/reference/id/metadata HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The reference's ID.
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+Required: Yes
- referenceStoreId
-
The reference's reference store ID.
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationJobId": "string",
"creationTime": "string",
"creationType": "string",
"description": "string",
"files": {
"index": {
"contentLength": number,
"partSize": number,
"s3Access": {
"s3Uri": "string"
},
"totalParts": number
},
"source": {
"contentLength": number,
"partSize": number,
"s3Access": {
"s3Uri": "string"
},
"totalParts": number
}
},
"id": "string",
"md5": "string",
"name": "string",
"referenceStoreId": "string",
"status": "string",
"updateTime": "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.
- arn
-
The reference's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
arn:.+ - creationJobId
-
The reference's creation job ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
[a-zA-Z0-9]+ - creationTime
-
When the reference was created.
Type: Timestamp
- creationType
-
The reference's creation type.
Type: String
Valid Values:
IMPORT - description
-
The reference's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+ - files
-
The reference's files.
Type: ReferenceFiles object
- id
-
The reference's ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+ - md5
-
The reference's MD5 checksum.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\p{L}||\p{N}]+ - name
-
The reference's name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+ - referenceStoreId
-
The reference's reference store ID.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 36.
Pattern:
[0-9]+ - status
-
The reference's status.
Type: String
Valid Values:
ACTIVE | DELETING | DELETED - updateTime
-
When the reference was updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred. Try the request again.
HTTP Status Code: 500
- RequestTimeoutException
-
The request timed out.
HTTP Status Code: 408
- ResourceNotFoundException
-
The target resource was not found in the current Region.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
