describe_package_group ¶

describe_package_group(
    domain: DomainName,
    package_group: PackageGroupPattern,
    *,
    config_overrides: Optional[codeartifactClientConfig] = None,
    domain_owner: Optional[AccountId] = None,
) -> DescribePackageGroupResult

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

Parameters:

domain (DomainName) –

The name of the domain that contains the package group.
domain_owner (Optional[AccountId], default: None ) –

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

The pattern of the requested package group.

Raises:

AccessDeniedException –

The operation did not succeed because of an unauthorized access attempt.
InternalServerException –

The operation did not succeed because of an error that occurred inside CodeArtifact.
ResourceNotFoundException –

The operation did not succeed because the resource requested is not found in the service.
ThrottlingException –

The operation did not succeed because too many requests are sent to the service.
ValidationException –

The operation did not succeed because a parameter in the request was sent with an invalid value.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_codeartifact/_services/codeartifact.py

def describe_package_group(
    self,
    domain: "capo_codeartifact.types.domain_name.DomainName",
    package_group: "capo_codeartifact.types.package_group_pattern.PackageGroupPattern",
    *,
    config_overrides: Optional[codeartifactClientConfig] = None,
    domain_owner: Optional["capo_codeartifact.types.account_id.AccountId"] = None,
) -> "capo_codeartifact.types.describe_package_group_result.DescribePackageGroupResult":
    """<p>Returns a <a href="https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html">PackageGroupDescription</a> object that contains information about the requested package group.</p>

    Args:
        domain: <p> The name of the domain that contains the package group. </p>
        domain_owner: <p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>
        package_group: <p>The pattern of the requested package group.</p>

    Raises:
        capo_codeartifact.errors.access_denied_exception.AccessDeniedException: <p> The operation did not succeed because of an unauthorized access attempt. </p>
        capo_codeartifact.errors.internal_server_exception.InternalServerException: <p> The operation did not succeed because of an error that occurred inside CodeArtifact. </p>
        capo_codeartifact.errors.resource_not_found_exception.ResourceNotFoundException: <p> The operation did not succeed because the resource requested is not found in the service. </p>
        capo_codeartifact.errors.throttling_exception.ThrottlingException: <p> The operation did not succeed because too many requests are sent to the service. </p>
        capo_codeartifact.errors.validation_exception.ValidationException: <p> The operation did not succeed because a parameter in the request was sent with an invalid value. </p>
        capo_codeartifact.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codeartifact.types.describe_package_group_request.DescribePackageGroupRequest]",
    ) -> OperationResponse[
        "capo_codeartifact.types.describe_package_group_result.DescribePackageGroupResult"
    ]:
        import capo_codeartifact._operations.code_artifact_control_plane_service.describe_package_group

        output, http_response = (
            capo_codeartifact._operations.code_artifact_control_plane_service.describe_package_group.describe_package_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePackageGroup")
    )
    input_: capo_codeartifact.types.describe_package_group_request.DescribePackageGroupRequest = {
        "domain": domain,
        "package_group": package_group,
    }
    if domain_owner is not None:
        input_["domain_owner"] = domain_owner

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output