Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRcsAgents

Retrieves the specified RCS agents or all RCS agents associated with your AWS account.

If you specify RCS agent IDs, the output includes information for only the specified RCS agents. If you specify filters, the output includes information for only those RCS agents that meet the filter criteria. If you don't specify RCS agent IDs or filters, the output includes information for all RCS agents.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "Owner": "string",
   "RcsAgentIds": [ "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

An array of RcsAgentFilter objects to filter the results.

Type: Array of RcsAgentFilter objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

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

Required: No

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Type: String

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

Pattern: .+

Required: No

Owner

Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.

Type: String

Valid Values: SELF | SHARED

Required: No

RcsAgentIds

An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

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

Pattern: [A-Za-z0-9_:/-]+

Required: No

Response Syntax


{
   "NextToken": "string",
   "RcsAgents": [ 
      { 
         "CreatedTimestamp": number,
         "DeletionProtectionEnabled": boolean,
         "OptOutListName": "string",
         "PoolId": "string",
         "RcsAgentArn": "string",
         "RcsAgentId": "string",
         "SelfManagedOptOutsEnabled": boolean,
         "Status": "string",
         "TestingAgent": { 
            "RegistrationId": "string",
            "Status": "string",
            "TestingAgentId": "string"
         },
         "TwoWayChannelArn": "string",
         "TwoWayChannelRole": "string",
         "TwoWayEnabled": boolean
      }
   ]
}

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

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Type: String

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

Pattern: .+

RcsAgents

An array of RcsAgentInformation objects that contain the details for the requested RCS agents.

Type: Array of RcsAgentInformation objects

Errors

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

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

Reason: The reason for the exception.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

RequestId: The unique identifier of the request.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

ResourceId: The unique identifier of the resource.
ResourceType: The type of resource that caused the exception.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

Fields: The field that failed validation.
Reason: The reason for the exception.

HTTP Status Code: 400