PinpointSMSVoiceV2 / Client / describe_rcs_agents

describe_rcs_agents

PinpointSMSVoiceV2.Client.describe_rcs_agents(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_rcs_agents(
    RcsAgentIds=[
        'string',
    ],
    Owner='SELF'|'SHARED',
    Filters=[
        {
            'Name': 'status'|'two-way-enabled'|'self-managed-opt-outs-enabled'|'opt-out-list-name'|'deletion-protection-enabled'|'two-way-channel-arn',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • RcsAgentIds (list) –

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

    • (string) –

  • Owner (string) – 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.

  • Filters (list) –

    An array of RcsAgentFilter objects to filter the results.

    • (dict) –

      The information for an RCS agent that meets a specified criteria.

      • Name (string) – [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) – [REQUIRED]

        An array values to filter for.

        • (string) –

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results to return per each request.

Return type:

dict

Returns:

Response Syntax

{
    'RcsAgents': [
        {
            'RcsAgentArn': 'string',
            'RcsAgentId': 'string',
            'Status': 'CREATED'|'PENDING'|'TESTING'|'PARTIAL'|'ACTIVE'|'DELETED',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'DeletionProtectionEnabled': True|False,
            'OptOutListName': 'string',
            'SelfManagedOptOutsEnabled': True|False,
            'TwoWayChannelArn': 'string',
            'TwoWayChannelRole': 'string',
            'TwoWayEnabled': True|False,
            'PoolId': 'string',
            'TestingAgent': {
                'Status': 'CREATED'|'PENDING'|'ACTIVE',
                'TestingAgentId': 'string',
                'RegistrationId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RcsAgents (list) –

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

      • (dict) –

        The information for an RCS agent in an Amazon Web Services account.

        • RcsAgentArn (string) –

          The Amazon Resource Name (ARN) of the RCS agent.

        • RcsAgentId (string) –

          The unique identifier for the RCS agent.

        • Status (string) –

          The current status of the RCS agent.

        • CreatedTimestamp (datetime) –

          The time when the RCS agent was created, in UNIX epoch time format.

        • DeletionProtectionEnabled (boolean) –

          When set to true the RCS agent can’t be deleted.

        • OptOutListName (string) –

          The name of the OptOutList associated with the RCS agent.

        • SelfManagedOptOutsEnabled (boolean) –

          When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out requests.

        • TwoWayChannelArn (string) –

          The Amazon Resource Name (ARN) of the two way channel.

        • TwoWayChannelRole (string) –

          An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

        • TwoWayEnabled (boolean) –

          When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

        • PoolId (string) –

          The unique identifier of the pool associated with the RCS agent.

        • TestingAgent (dict) –

          The testing agent information associated with the RCS agent.

          • Status (string) –

            The current status of the testing agent.

          • TestingAgentId (string) –

            The unique identifier for the testing agent.

          • RegistrationId (string) –

            The unique identifier of the registration associated with the testing agent.

    • NextToken (string) –

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

Exceptions