Skip to content

DescribeRcsAgentsRequest

Source code in docs_src/capo_pinpoint_sms_voice_v2/types/describe_rcs_agents_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class DescribeRcsAgentsRequest(TypedDict, closed=True):
    rcs_agent_ids: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_agent_id_list.RcsAgentIdList"
    ]
    """<p>An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.</p>"""
    owner: NotRequired["capo_pinpoint_sms_voice_v2.types.owner.Owner"]
    """<p>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.</p>"""
    filters: NotRequired[
        "capo_pinpoint_sms_voice_v2.types.rcs_agent_filter_list.RcsAgentFilterList"
    ]
    """<p>An array of RcsAgentFilter objects to filter the results.</p>"""
    next_token: NotRequired["capo_pinpoint_sms_voice_v2.types.next_token.NextToken"]
    """<p>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.</p>"""
    max_results: NotRequired["capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per each request.</p>"""

filters instance-attribute 

filters: NotRequired[RcsAgentFilterList]

An array of RcsAgentFilter objects to filter the results.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per each request.

next_token instance-attribute 

next_token: NotRequired[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.

owner instance-attribute 

owner: NotRequired[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.

rcs_agent_ids instance-attribute 

rcs_agent_ids: NotRequired[RcsAgentIdList]

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