:doc:`ApiGatewayV2 <../../apigatewayv2>` / Client / create_portal_product

*********************
create_portal_product
*********************



.. py:method:: ApiGatewayV2.Client.create_portal_product(**kwargs)

  

  Creates a new portal product.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/apigatewayv2-2018-11-29/CreatePortalProduct>`_  


  **Request Syntax**
  ::

    response = client.create_portal_product(
        Description='string',
        DisplayName='string',
        Tags={
            'string': 'string'
        }
    )
    
  :type Description: string
  :param Description: 

    A description of the portal product.

    

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

    The name of the portal product as it appears in a published portal.

    

  
  :type Tags: dict
  :param Tags: 

    The collection of tags. Each tag element is associated with a given resource.

    

  
    - *(string) --* 

    
      - *(string) --* 

        A string with a length between [0-1600].

        

      


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

    
    ::

      {
          'Description': 'string',
          'DisplayName': 'string',
          'DisplayOrder': {
              'Contents': [
                  {
                      'ProductRestEndpointPageArns': [
                          'string',
                      ],
                      'SectionName': 'string'
                  },
              ],
              'OverviewPageArn': 'string',
              'ProductPageArns': [
                  'string',
              ]
          },
          'LastModified': datetime(2015, 1, 1),
          'PortalProductArn': 'string',
          'PortalProductId': 'string',
          'Tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The request has succeeded and has resulted in the creation of a resource.

      
      

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

        A description of the portal product.

        
      

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

        The display name for the portal product.

        
      

      - **DisplayOrder** *(dict) --* 

        The visual ordering of the product pages and product REST endpoint pages in a published portal.

        
        

        - **Contents** *(list) --* 

          Represents a list of sections which include section name and list of product REST endpoints for a product.

          
          

          - *(dict) --* 

            Contains the section name and list of product REST endpoints for a product.

            
            

            - **ProductRestEndpointPageArns** *(list) --* 

              The ARNs of the product REST endpoint pages in a portal product.

              
              

              - *(string) --* 
          
            

            - **SectionName** *(string) --* 

              The section name.

              
        
      
        

        - **OverviewPageArn** *(string) --* 

          The ARN of the overview page.

          
        

        - **ProductPageArns** *(list) --* 

          The product page ARNs.

          
          

          - *(string) --* 
      
    
      

      - **LastModified** *(datetime) --* 

        The timestamp when the portal product was last modified.

        
      

      - **PortalProductArn** *(string) --* 

        The ARN of the portal product.

        
      

      - **PortalProductId** *(string) --* 

        The portal product identifier.

        
      

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

        The collection of tags. Each tag element is associated with a given resource.

        
        

        - *(string) --* 
          

          - *(string) --* 

            A string with a length between [0-1600].

            
    
  
  
  **Exceptions**
  
  *   :py:class:`ApiGatewayV2.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`ApiGatewayV2.Client.exceptions.BadRequestException`

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

  