:doc:`EKS <../../eks>` / Client / describe_fargate_profile

************************
describe_fargate_profile
************************



.. py:method:: EKS.Client.describe_fargate_profile(**kwargs)

  

  Describes an Fargate profile.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeFargateProfile>`_  


  **Request Syntax**
  ::

    response = client.describe_fargate_profile(
        clusterName='string',
        fargateProfileName='string'
    )
    
  :type clusterName: string
  :param clusterName: **[REQUIRED]** 

    The name of your cluster.

    

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

    The name of the Fargate profile to describe.

    

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

    
    ::

      {
          'fargateProfile': {
              'fargateProfileName': 'string',
              'fargateProfileArn': 'string',
              'clusterName': 'string',
              'createdAt': datetime(2015, 1, 1),
              'podExecutionRoleArn': 'string',
              'subnets': [
                  'string',
              ],
              'selectors': [
                  {
                      'namespace': 'string',
                      'labels': {
                          'string': 'string'
                      }
                  },
              ],
              'status': 'CREATING'|'ACTIVE'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED',
              'tags': {
                  'string': 'string'
              },
              'health': {
                  'issues': [
                      {
                          'code': 'PodExecutionRoleAlreadyInUse'|'AccessDenied'|'ClusterUnreachable'|'InternalFailure',
                          'message': 'string',
                          'resourceIds': [
                              'string',
                          ]
                      },
                  ]
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **fargateProfile** *(dict) --* 

        The full description of your Fargate profile.

        
        

        - **fargateProfileName** *(string) --* 

          The name of the Fargate profile.

          
        

        - **fargateProfileArn** *(string) --* 

          The full Amazon Resource Name (ARN) of the Fargate profile.

          
        

        - **clusterName** *(string) --* 

          The name of your cluster.

          
        

        - **createdAt** *(datetime) --* 

          The Unix epoch timestamp at object creation.

          
        

        - **podExecutionRoleArn** *(string) --* 

          The Amazon Resource Name (ARN) of the ``Pod`` execution role to use for any ``Pod`` that matches the selectors in the Fargate profile. For more information, see `Pod execution role <https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html>`__ in the *Amazon EKS User Guide*.

          
        

        - **subnets** *(list) --* 

          The IDs of subnets to launch a ``Pod`` into.

          
          

          - *(string) --* 
      
        

        - **selectors** *(list) --* 

          The selectors to match for a ``Pod`` to use this Fargate profile.

          
          

          - *(dict) --* 

            An object representing an Fargate profile selector.

            
            

            - **namespace** *(string) --* 

              The Kubernetes ``namespace`` that the selector should match.

              
            

            - **labels** *(dict) --* 

              The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **status** *(string) --* 

          The current status of the Fargate profile.

          
        

        - **tags** *(dict) --* 

          Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

          
          

          - *(string) --* 

            One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.

            
            

            - *(string) --* 

              The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).

              
      
    
        

        - **health** *(dict) --* 

          The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

          
          

          - **issues** *(list) --* 

            Any issues that are associated with the Fargate profile.

            
            

            - *(dict) --* 

              An issue that is associated with the Fargate profile.

              
              

              - **code** *(string) --* 

                A brief description of the error.

                
              

              - **message** *(string) --* 

                The error message associated with the issue.

                
              

              - **resourceIds** *(list) --* 

                The Amazon Web Services resources that are affected by this issue.

                
                

                - *(string) --* 
            
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`EKS.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`EKS.Client.exceptions.ClientException`

  
  *   :py:class:`EKS.Client.exceptions.ServerException`

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

  