AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codeartifact ]

describe-package-group

Description

Returns a PackageGroupDescription object that contains information about the requested package group.

See also: AWS API Documentation

Synopsis

  describe-package-group
--domain <value>
[--domain-owner <value>]
--package-group <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain (string)

The name of the domain that contains the package group.

--domain-owner (string)

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

--package-group (string)

The pattern of the requested package group.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

packageGroup -> (structure)

A PackageGroupDescription object that contains information about the requested 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 name of 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 -> (timestamp)

A timestamp that represents the date and time the package group was created.

contactInfo -> (string)

The contact information of the package group.

description -> (string)

The description of the package group.

originConfiguration -> (structure)

The package group origin configuration that determines how package versions can enter repositories.

restrictions -> (map)

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

key -> (string)

value -> (structure)

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 -> (structure)

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 -> (long)

The number of repositories in the allowed repository list.

parent -> (structure)

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.