:doc:`ServiceCatalog <../../servicecatalog>` / Client / describe_portfolio

******************
describe_portfolio
******************



.. py:method:: ServiceCatalog.Client.describe_portfolio(**kwargs)

  

  Gets information about the specified portfolio.

   

  A delegated admin is authorized to invoke this command.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/DescribePortfolio>`_  


  **Request Syntax**
  ::

    response = client.describe_portfolio(
        AcceptLanguage='string',
        Id='string'
    )
    
  :type AcceptLanguage: string
  :param AcceptLanguage: 

    The language code.

     

    
    * ``jp`` - Japanese
     
    * ``zh`` - Chinese
    

    

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

    The portfolio identifier.

    

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

    
    ::

      {
          'PortfolioDetail': {
              'Id': 'string',
              'ARN': 'string',
              'DisplayName': 'string',
              'Description': 'string',
              'CreatedTime': datetime(2015, 1, 1),
              'ProviderName': 'string'
          },
          'Tags': [
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ],
          'TagOptions': [
              {
                  'Key': 'string',
                  'Value': 'string',
                  'Active': True|False,
                  'Id': 'string',
                  'Owner': 'string'
              },
          ],
          'Budgets': [
              {
                  'BudgetName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PortfolioDetail** *(dict) --* 

        Information about the portfolio.

        
        

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

          The portfolio identifier.

          
        

        - **ARN** *(string) --* 

          The ARN assigned to the portfolio.

          
        

        - **DisplayName** *(string) --* 

          The name to use for display purposes.

          
        

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

          The description of the portfolio.

          
        

        - **CreatedTime** *(datetime) --* 

          The UTC time stamp of the creation time.

          
        

        - **ProviderName** *(string) --* 

          The name of the portfolio provider.

          
    
      

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

        Information about the tags associated with the portfolio.

        
        

        - *(dict) --* 

          Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

          
          

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

            The tag key.

            
          

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

            The value for this key.

            
      
    
      

      - **TagOptions** *(list) --* 

        Information about the TagOptions associated with the portfolio.

        
        

        - *(dict) --* 

          Information about a TagOption.

          
          

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

            The TagOption key.

            
          

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

            The TagOption value.

            
          

          - **Active** *(boolean) --* 

            The TagOption active state.

            
          

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

            The TagOption identifier.

            
          

          - **Owner** *(string) --* 

            The Amazon Web Services account Id of the owner account that created the TagOption.

            
      
    
      

      - **Budgets** *(list) --* 

        Information about the associated budgets.

        
        

        - *(dict) --* 

          Information about a budget.

          
          

          - **BudgetName** *(string) --* 

            Name of the associated budget.

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

  