PinpointSMSVoiceV2 / Client / describe_rcs_agent_country_launch_status

describe_rcs_agent_country_launch_status¶

PinpointSMSVoiceV2.Client.describe_rcs_agent_country_launch_status(**kwargs)¶

Retrieves the per-country launch status of an RCS agent, including carrier-level details for each country.

Request Syntax

response = client.describe_rcs_agent_country_launch_status(
    RcsAgentId='string',
    IsoCountryCodes=[
        'string',
    ],
    Filters=[
        {
            'Name': 'country-launch-status',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

RcsAgentId (string) –
[REQUIRED]

The unique identifier of the RCS agent. You can use either the RcsAgentId or RcsAgentArn.
IsoCountryCodes (list) –
An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.
- (string) –
Filters (list) –
An array of CountryLaunchStatusFilter objects to filter the results.
- (dict) –
  
  The information for a country launch status 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) –
MaxResults (integer) – The maximum number of results to return per each request.
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.

Return type:

dict

Returns:

Response Syntax

{
    'RcsAgentId': 'string',
    'RcsAgentArn': 'string',
    'CountryLaunchStatus': [
        {
            'IsoCountryCode': 'string',
            'Status': 'CREATED'|'PENDING'|'PARTIAL'|'ACTIVE'|'REJECTED',
            'RcsPlatformId': 'string',
            'RegistrationId': 'string',
            'CarrierStatus': [
                {
                    'CarrierName': 'string',
                    'Status': 'PENDING'|'ACTIVE'|'REJECTED'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RcsAgentId (string) –
  
  The unique identifier for the RCS agent.
- RcsAgentArn (string) –
  
  The Amazon Resource Name (ARN) of the RCS agent.
- CountryLaunchStatus (list) –
  
  An array of CountryLaunchStatusInformation objects that contain the per-country launch status details.
  - (dict) –
    
    Contains per-country launch status details for an RCS agent.
    - IsoCountryCode (string) –
      
      The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    - Status (string) –
      
      The launch status for this country.
    - RcsPlatformId (string) –
      
      The RCS platform identifier for this country.
    - RegistrationId (string) –
      
      The unique identifier of the registration associated with this country launch.
    - CarrierStatus (list) –
      
      An array of CarrierStatusInformation objects containing carrier-level launch status details.
      - (dict) –
        
        Contains carrier-level launch status details for an RCS agent within a country.
        
        CarrierName (string) –
        
        The name of the carrier.
        
        Status (string) –
        
        The launch status for this carrier.
- 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

PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException