Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListArchives

Returns a list of all email archives in your account.

Request Syntax


{
   "NextToken": "string",
   "PageSize": number
}

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.

NextToken

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

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

Required: No

PageSize

The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.

Type: Integer

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

Required: No

Response Syntax


{
   "Archives": [ 
      { 
         "ArchiveId": "string",
         "ArchiveName": "string",
         "ArchiveState": "string",
         "LastUpdatedTimestamp": number
      }
   ],
   "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.

Archives

The list of archive details.

Type: Array of Archive objects

NextToken

If present, use to retrieve the next page of results.

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.

AccessDeniedException

Occurs when a user is denied access to a specific resource or action.

HTTP Status Code: 400

ThrottlingException

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.

HTTP Status Code: 400

ValidationException

The request validation has failed. For details, see the accompanying error message.

HTTP Status Code: 400