ListRfcCorrespondences - AWS Managed Services

ListRfcCorrespondences

List the existing correspondences of an RFC.

Request Syntax

{ "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "Locale": "string", "MaxResults": number, "NextToken": "string" }

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.

Filters

The only valid filter attribute is RfcId, and a value is required.

Type: Array of Filter objects

Required: No

Locale

The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.

Type: String

Required: No

MaxResults

The maximum number of items to return in one batch. Valid values are 20-100.

Type: Integer

Required: No

NextToken

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

Required: No

Response Syntax

{ "NextToken": "string", "RfcCorrespondences": [ { "Content": "string", "CorrespondenceId": "string", "CreatedBy": "string", "CreatedTime": "string", "LinkedAttachments": [ { "AttachmentId": "string", "CreatedBy": "string", "CreatedTime": "string", "FileName": "string" } ], "RfcId": "string", "UserType": { "Id": "string", "Name": "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.

NextToken

If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.

Type: String

RfcCorrespondences

The list of correspondences for an existing RFC.

Type: Array of RfcCorrespondence objects

Errors

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

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500

InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: