:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Client / describe_protect_configurations

*******************************
describe_protect_configurations
*******************************



.. py:method:: PinpointSMSVoiceV2.Client.describe_protect_configurations(**kwargs)

  

  Retrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.

  

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


  **Request Syntax**
  ::

    response = client.describe_protect_configurations(
        ProtectConfigurationIds=[
            'string',
        ],
        Filters=[
            {
                'Name': 'account-default'|'deletion-protection-enabled',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :type ProtectConfigurationIds: list
  :param ProtectConfigurationIds: 

    An array of protect configuration identifiers to search for.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    An array of ProtectConfigurationFilter objects to filter the results.

    

  
    - *(dict) --* 

      The filter definition for filtering protect configurations that meet 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 NextToken: string
  :param 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.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per each request.

    

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

    
    ::

      {
          'ProtectConfigurations': [
              {
                  'ProtectConfigurationArn': 'string',
                  'ProtectConfigurationId': 'string',
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'AccountDefault': True|False,
                  'DeletionProtectionEnabled': True|False
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ProtectConfigurations** *(list) --* 

        An array of ProtectConfigurationInformation objects that contain the details for the request.

        
        

        - *(dict) --* 

          Provides information on the specified protect configuration.

          
          

          - **ProtectConfigurationArn** *(string) --* 

            The Amazon Resource Name (ARN) of the protect configuration.

            
          

          - **ProtectConfigurationId** *(string) --* 

            The unique identifier for the protect configuration.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The time when the protect configuration was created, in `UNIX epoch time <https://www.epochconverter.com/>`__ format.

            
          

          - **AccountDefault** *(boolean) --* 

            This is true if the protect configuration is set as your account default protect configuration.

            
          

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

            The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

            
      
    
      

      - **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.

        
  
  **Exceptions**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ValidationException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.InternalServerException`

  