GetListing
Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.
Request Syntax
GET /v2/domains/domainIdentifier/listings/identifier?listingRevision=listingRevision HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the Amazon DataZone domain.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The ID of the listing.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
- listingRevision
-
The revision of the listing.
Length Constraints: Minimum length of 1. Maximum length of 64.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": number,
"createdBy": "string",
"description": "string",
"domainId": "string",
"id": "string",
"item": { ... },
"listingRevision": "string",
"name": "string",
"status": "string",
"updatedAt": number,
"updatedBy": "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.
- createdAt
-
The timestamp of when the listing was created.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who created the listing.
Type: String
- description
-
The description of the listing.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The ID of the Amazon DataZone domain.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - id
-
The ID of the listing.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - item
-
The details of a listing.
Type: ListingItem object
Note: This object is a Union. Only one member of this object can be specified or returned.
- listingRevision
-
The revision of a listing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- name
-
The name of the listing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- status
-
The status of the listing.
Type: String
Valid Values:
CREATING | ACTIVE | INACTIVE - updatedAt
-
The timestamp of when the listing was updated.
Type: Timestamp
- updatedBy
-
The Amazon DataZone user who updated the listing.
Type: String
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
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the 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:
