:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Paginator / DescribeSenderIds

*****************
DescribeSenderIds
*****************



.. py:class:: PinpointSMSVoiceV2.Paginator.DescribeSenderIds

  ::

    
    paginator = client.get_paginator('describe_sender_ids')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PinpointSMSVoiceV2.Client.describe_sender_ids`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DescribeSenderIds>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SenderIds=[
              {
                  'SenderId': 'string',
                  'IsoCountryCode': 'string'
              },
          ],
          Filters=[
              {
                  'Name': 'sender-id'|'iso-country-code'|'message-type'|'deletion-protection-enabled'|'registered',
                  'Values': [
                      'string',
                  ]
              },
          ],
          Owner='SELF'|'SHARED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SenderIds: list
    :param SenderIds: 

      An array of SenderIdAndCountry objects to search for.

       

      .. warning::

         

        If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

        

      

    
      - *(dict) --* 

        The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see `Requesting sender IDs <https://docs.aws.amazon.com/sms-voice/latest/userguide/sender-id-request.html>`__ in the *End User Messaging SMS User Guide*.

        

      
        - **SenderId** *(string) --* **[REQUIRED]** 

          The unique identifier of the sender.

          

        
        - **IsoCountryCode** *(string) --* **[REQUIRED]** 

          The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

          

        
      
  
    :type Filters: list
    :param Filters: 

      An array of SenderIdFilter objects to filter the results.

      

    
      - *(dict) --* 

        The information for a sender ID that meets a specified criteria.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the attribute to filter on.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          An array of values to filter for.

          

        
          - *(string) --* 

          
      
      
  
    :type Owner: string
    :param Owner: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'SenderIds': [
                {
                    'SenderIdArn': 'string',
                    'SenderId': 'string',
                    'IsoCountryCode': 'string',
                    'MessageTypes': [
                        'TRANSACTIONAL'|'PROMOTIONAL',
                    ],
                    'MonthlyLeasingPrice': 'string',
                    'DeletionProtectionEnabled': True|False,
                    'Registered': True|False,
                    'RegistrationId': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **SenderIds** *(list) --* 

          An array of SernderIdInformation objects that contain the details for the requested SenderIds.

          
          

          - *(dict) --* 

            The information for all SenderIds in an Amazon Web Services account.

            
            

            - **SenderIdArn** *(string) --* 

              The Amazon Resource Name (ARN) associated with the SenderId.

              
            

            - **SenderId** *(string) --* 

              The alphanumeric sender ID in a specific country that you'd like to describe.

              
            

            - **IsoCountryCode** *(string) --* 

              The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

              
            

            - **MessageTypes** *(list) --* 

              The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

              
              

              - *(string) --* 
          
            

            - **MonthlyLeasingPrice** *(string) --* 

              The monthly leasing price, in US dollars.

              
            

            - **DeletionProtectionEnabled** *(boolean) --* 

              By default this is set to false. When set to true the sender ID can't be deleted.

              
            

            - **Registered** *(boolean) --* 

              True if the sender ID is registered.

              
            

            - **RegistrationId** *(string) --* 

              The unique identifier for the registration.

              
        
      
    