:doc:`CodeArtifact <../../codeartifact>` / Client / list_sub_package_groups

***********************
list_sub_package_groups
***********************



.. py:method:: CodeArtifact.Client.list_sub_package_groups(**kwargs)

  

  Returns a list of direct children of the specified package group.

   

  For information package group hierarchy, see `Package group definition syntax and matching behavior <https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html>`__ in the *CodeArtifact User Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListSubPackageGroups>`_  


  **Request Syntax**
  ::

    response = client.list_sub_package_groups(
        domain='string',
        domainOwner='string',
        packageGroup='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

    The name of the domain which contains the package group from which to list sub package groups.

    

  
  :type domainOwner: string
  :param domainOwner: 

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

    

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

    The pattern of the package group from which to list sub package groups.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

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

    
    ::

      {
          'packageGroups': [
              {
                  'arn': 'string',
                  'pattern': 'string',
                  'domainName': 'string',
                  'domainOwner': 'string',
                  'createdTime': datetime(2015, 1, 1),
                  'contactInfo': 'string',
                  'description': 'string',
                  'originConfiguration': {
                      'restrictions': {
                          'string': {
                              'mode': 'ALLOW'|'ALLOW_SPECIFIC_REPOSITORIES'|'BLOCK'|'INHERIT',
                              'effectiveMode': 'ALLOW'|'ALLOW_SPECIFIC_REPOSITORIES'|'BLOCK'|'INHERIT',
                              'inheritedFrom': {
                                  'arn': 'string',
                                  'pattern': 'string'
                              },
                              'repositoriesCount': 123
                          }
                      }
                  },
                  'parent': {
                      'arn': 'string',
                      'pattern': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **packageGroups** *(list) --* 

        A list of sub package groups for the requested package group.

        
        

        - *(dict) --* 

          Details about a package group.

          
          

          - **arn** *(string) --* 

            The ARN of the package group.

            
          

          - **pattern** *(string) --* 

            The pattern of the package group. The pattern determines which packages are associated with the package group.

            
          

          - **domainName** *(string) --* 

            The domain that contains the package group.

            
          

          - **domainOwner** *(string) --* 

            The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

            
          

          - **createdTime** *(datetime) --* 

            A timestamp that represents the date and time the repository was created.

            
          

          - **contactInfo** *(string) --* 

            The contact information of the package group.

            
          

          - **description** *(string) --* 

            The description of the package group.

            
          

          - **originConfiguration** *(dict) --* 

            Details about the package origin configuration of a package group.

            
            

            - **restrictions** *(dict) --* 

              The origin configuration settings that determine how package versions can enter repositories.

              
              

              - *(string) --* 
                

                - *(dict) --* 

                  Contains information about the configured restrictions of the origin controls of a package group.

                  
                  

                  - **mode** *(string) --* 

                    The package group origin restriction setting. If the value of ``mode`` is ``ALLOW``, ``ALLOW_SPECIFIC_REPOSITORIES``, or ``BLOCK``, then the value of ``effectiveMode`` is the same. Otherwise, when the value is ``INHERIT``, then the value of ``effectiveMode`` is the value of ``mode`` of the first parent group which does not have a value of ``INHERIT``.

                    
                  

                  - **effectiveMode** *(string) --* 

                    The effective package group origin restriction setting. If the value of ``mode`` is ``ALLOW``, ``ALLOW_SPECIFIC_REPOSITORIES``, or ``BLOCK``, then the value of ``effectiveMode`` is the same. Otherwise, when the value of ``mode`` is ``INHERIT``, then the value of ``effectiveMode`` is the value of ``mode`` of the first parent group which does not have a value of ``INHERIT``.

                    
                  

                  - **inheritedFrom** *(dict) --* 

                    The parent package group that the package group origin restrictions are inherited from.

                    
                    

                    - **arn** *(string) --* 

                      The ARN of the package group.

                      
                    

                    - **pattern** *(string) --* 

                      The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

                      
                
                  

                  - **repositoriesCount** *(integer) --* 

                    The number of repositories in the allowed repository list.

                    
              
          
        
        
          

          - **parent** *(dict) --* 

            The direct parent package group of the package group.

            
            

            - **arn** *(string) --* 

              The ARN of the package group.

              
            

            - **pattern** *(string) --* 

              The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.

              
        
      
    
      

      - **nextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`CodeArtifact.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`CodeArtifact.Client.exceptions.ValidationException`

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

  