Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListItems

Provides a list of metadata entries about folders and objects in the specified folder.

The ListItems response does not include objects that are subject to a transient data rule (objects expire within seconds) in an object lifecycle policy. For more information about rules in object lifecycle policies, see Components of an Object Lifecycle Policy in the AWS Elemental MediaStore User Guide.

Request Syntax


GET /?MaxResults=MaxResults&NextToken=NextToken&Path=Path HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

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

NextToken

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Path

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Length Constraints: Minimum length of 0. Maximum length of 900.

Pattern: /?(?:[A-Za-z0-9_=:\.\-\~]+/){0,10}(?:[A-Za-z0-9_=:\.\-\~]+)?/?

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "ContentLength": number,
         "ContentType": "string",
         "ETag": "string",
         "LastModified": number,
         "Name": "string",
         "Type": "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.

Items

The metadata entries for the folders and objects at the requested path.

Type: Array of Item objects

NextToken

The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

Type: String

Errors

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

ContainerNotFoundException

The specified container was not found for the specified account.

HTTP Status Code: 404

InternalServerError

The service is temporarily unavailable.

HTTP Status Code: 500