Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Retrieves the specified RCS agents or all RCS agents associated with your Amazon Web Services 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.

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribeRcsAgents

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribeRcsAgents' required

Request body

RcsAgentIdsRcsAgentIdOrArn[]

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

Owner'SELF' | 'SHARED'

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

NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Response

Success

NextTokenstring

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