CodeArtifact / Client / list_package_groups

list_package_groups#

CodeArtifact.Client.list_package_groups(**kwargs)#

Returns a list of package groups in the requested domain.

See also: AWS API Documentation

Request Syntax

response = client.list_package_groups(
    domain='string',
    domainOwner='string',
    maxResults=123,
    nextToken='string',
    prefix='string'
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The domain for which you want to list package groups.

  • domainOwner (string) – The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – 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.

  • prefix (string) – A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.

Return type:

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) –

      The list of package groups in the requested domain.

      • (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) –

      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.

Exceptions