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

GetResources

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Request Syntax


GET /api/v1/resources?collectionType=CollectionType&limit=Limit&marker=Marker&userId=UserId HTTP/1.1
Authentication: AuthenticationToken

URI Request Parameters

The request uses the following URI parameters.

AuthenticationToken

The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Length Constraints: Minimum length of 1. Maximum length of 8199.

CollectionType

The collection type.

Valid Values: SHARED_WITH_ME

Limit

The maximum number of resources to return.

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

Marker

The marker for the next set of results. This marker was received from a previous call.

Length Constraints: Minimum length of 1. Maximum length of 2048.

UserId

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [&\w+-.@]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Documents": [ 
      { 
         "CreatedTimestamp": number,
         "CreatorId": "string",
         "Id": "string",
         "Labels": [ "string" ],
         "LatestVersionMetadata": { 
            "ContentCreatedTimestamp": number,
            "ContentModifiedTimestamp": number,
            "ContentType": "string",
            "CreatedTimestamp": number,
            "CreatorId": "string",
            "Id": "string",
            "ModifiedTimestamp": number,
            "Name": "string",
            "Signature": "string",
            "Size": number,
            "Source": { 
               "string" : "string" 
            },
            "Status": "string",
            "Thumbnail": { 
               "string" : "string" 
            }
         },
         "ModifiedTimestamp": number,
         "ParentFolderId": "string",
         "ResourceState": "string"
      }
   ],
   "Folders": [ 
      { 
         "CreatedTimestamp": number,
         "CreatorId": "string",
         "Id": "string",
         "Labels": [ "string" ],
         "LatestVersionSize": number,
         "ModifiedTimestamp": number,
         "Name": "string",
         "ParentFolderId": "string",
         "ResourceState": "string",
         "Signature": "string",
         "Size": number
      }
   ],
   "Marker": "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.

Documents

The documents in the specified collection.

Type: Array of DocumentMetadata objects

Folders

The folders in the specified folder.

Type: Array of FolderMetadata objects

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

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

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

InvalidArgumentException

The pagination marker or limit fields are not valid.

HTTP Status Code: 400

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404