:doc:`Transfer <../../transfer>` / Client / describe_profile

****************
describe_profile
****************



.. py:method:: Transfer.Client.describe_profile(**kwargs)

  

  Returns the details of the profile that's specified by the ``ProfileId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeProfile>`_  


  **Request Syntax**
  ::

    response = client.describe_profile(
        ProfileId='string'
    )
    
  :type ProfileId: string
  :param ProfileId: **[REQUIRED]** 

    The identifier of the profile that you want described.

    

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

    
    ::

      {
          'Profile': {
              'Arn': 'string',
              'ProfileId': 'string',
              'ProfileType': 'LOCAL'|'PARTNER',
              'As2Id': 'string',
              'CertificateIds': [
                  'string',
              ],
              'Tags': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Profile** *(dict) --* 

        The details of the specified profile, returned as an object.

        
        

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

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

          
        

        - **ProfileId** *(string) --* 

          A unique identifier for the local or partner AS2 profile.

          
        

        - **ProfileType** *(string) --* 

          Indicates whether to list only ``LOCAL`` type profiles or only ``PARTNER`` type profiles. If not supplied in the request, the command lists all types of profiles.

          
        

        - **As2Id** *(string) --* 

          The ``As2Id`` is the *AS2-name*, as defined in the `RFC 4130 <https://datatracker.ietf.org/doc/html/rfc4130>`__. For inbound transfers, this is the ``AS2-From`` header for the AS2 messages sent from the partner. For outbound connectors, this is the ``AS2-To`` header for the AS2 messages sent to the partner using the ``StartFileTransfer`` API operation. This ID cannot include spaces.

          
        

        - **CertificateIds** *(list) --* 

          An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

          
          

          - *(string) --* 
      
        

        - **Tags** *(list) --* 

          Key-value pairs that can be used to group and search for profiles.

          
          

          - *(dict) --* 

            Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called ``Group`` and assign the values ``Research`` and ``Accounting`` to that group.

            
            

            - **Key** *(string) --* 

              The name assigned to the tag that you create.

              
            

            - **Value** *(string) --* 

              Contains one or more values that you assigned to the key name you create.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Transfer.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Transfer.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Transfer.Client.exceptions.InternalServiceError`

  
  *   :py:class:`Transfer.Client.exceptions.ServiceUnavailableException`

  