:doc:`Connect <../../connect>` / Client / describe_security_profile

*************************
describe_security_profile
*************************



.. py:method:: Connect.Client.describe_security_profile(**kwargs)

  

  Gets basic information about the security profile.

   

  For information about security profiles, see `Security Profiles <https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html>`__ in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see `List of security profile permissions <https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfile>`_  


  **Request Syntax**
  ::

    response = client.describe_security_profile(
        SecurityProfileId='string',
        InstanceId='string'
    )
    
  :type SecurityProfileId: string
  :param SecurityProfileId: **[REQUIRED]** 

    The identifier for the security profle.

    

  
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

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

    
    ::

      {
          'SecurityProfile': {
              'Id': 'string',
              'OrganizationResourceId': 'string',
              'Arn': 'string',
              'SecurityProfileName': 'string',
              'Description': 'string',
              'Tags': {
                  'string': 'string'
              },
              'AllowedAccessControlTags': {
                  'string': 'string'
              },
              'TagRestrictedResources': [
                  'string',
              ],
              'LastModifiedTime': datetime(2015, 1, 1),
              'LastModifiedRegion': 'string',
              'HierarchyRestrictedResources': [
                  'string',
              ],
              'AllowedAccessControlHierarchyGroupId': 'string',
              'GranularAccessControlConfiguration': {
                  'DataTableAccessControlConfiguration': {
                      'PrimaryAttributeAccessControlConfiguration': {
                          'PrimaryAttributeValues': [
                              {
                                  'AccessType': 'ALLOW',
                                  'AttributeName': 'string',
                                  'Values': [
                                      'string',
                                  ]
                              },
                          ]
                      }
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SecurityProfile** *(dict) --* 

        The security profile.

        
        

        - **Id** *(string) --* 

          The identifier for the security profile.

          
        

        - **OrganizationResourceId** *(string) --* 

          The organization resource identifier for the security profile.

          
        

        - **Arn** *(string) --* 

          The Amazon Resource Name (ARN) for the security profile.

          
        

        - **SecurityProfileName** *(string) --* 

          The name for the security profile.

          
        

        - **Description** *(string) --* 

          The description of the security profile.

          
        

        - **Tags** *(dict) --* 

          The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **AllowedAccessControlTags** *(dict) --* 

          The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **TagRestrictedResources** *(list) --* 

          The list of resources that a security profile applies tag restrictions to in Amazon Connect.

          
          

          - *(string) --* 
      
        

        - **LastModifiedTime** *(datetime) --* 

          The timestamp when this resource was last modified.

          
        

        - **LastModifiedRegion** *(string) --* 

          The Amazon Web Services Region where this resource was last modified.

          
        

        - **HierarchyRestrictedResources** *(list) --* 

          The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: ``User``.

          
          

          - *(string) --* 
      
        

        - **AllowedAccessControlHierarchyGroupId** *(string) --* 

          The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.

          
        

        - **GranularAccessControlConfiguration** *(dict) --* 

          The granular access control configuration for the security profile, including data table permissions.

          
          

          - **DataTableAccessControlConfiguration** *(dict) --* 

            The access control configuration for data tables.

            
            

            - **PrimaryAttributeAccessControlConfiguration** *(dict) --* 

              The configuration's primary attribute access control configuration.

              
              

              - **PrimaryAttributeValues** *(list) --* 

                The item's primary attribute values.

                
                

                - *(dict) --* 

                  A primary attribute value.

                  
                  

                  - **AccessType** *(string) --* 

                    The value's access type.

                    
                  

                  - **AttributeName** *(string) --* 

                    The value's attribute name.

                    
                  

                  - **Values** *(list) --* 

                    The value's values.

                    
                    

                    - *(string) --* 
                
              
            
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

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

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  