libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeArtifact.DescribePackageVersion

Description

Returns a PackageVersionDescription object that contains information about the requested package version.

Synopsis

Creating a Request

data DescribePackageVersion Source #

See: newDescribePackageVersion smart constructor.

Constructors

DescribePackageVersion' 

Fields

  • namespace :: Maybe Text

    The namespace of the package. The package component that specifies its namespace depends on its type. For example:

    • The namespace of a Maven package is its groupId.
    • The namespace of an npm package is its scope.
    • A Python package does not contain a corresponding component, so Python packages do not have a namespace.
  • domainOwner :: Maybe Text

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

  • domain :: Text

    The name of the domain that contains the repository that contains the package version.

  • repository :: Text

    The name of the repository that contains the package version.

  • format :: PackageFormat

    A format that specifies the type of the requested package version. The valid values are:

    • npm
    • pypi
    • maven
  • package :: Text

    The name of the requested package version.

  • packageVersion :: Text

    A string that contains the package version (for example, 3.5.2).

Instances

Instances details
Eq DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Read DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Show DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Generic DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Associated Types

type Rep DescribePackageVersion :: Type -> Type #

NFData DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Methods

rnf :: DescribePackageVersion -> () #

Hashable DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

AWSRequest DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Associated Types

type AWSResponse DescribePackageVersion #

ToHeaders DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

ToPath DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

ToQuery DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

type Rep DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

type Rep DescribePackageVersion = D1 ('MetaData "DescribePackageVersion" "Amazonka.CodeArtifact.DescribePackageVersion" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "DescribePackageVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageFormat)) :*: (S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "packageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribePackageVersion Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

newDescribePackageVersion Source #

Create a value of DescribePackageVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespace:DescribePackageVersion', describePackageVersion_namespace - The namespace of the package. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package is its groupId.
  • The namespace of an npm package is its scope.
  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

$sel:domainOwner:DescribePackageVersion', describePackageVersion_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

$sel:domain:DescribePackageVersion', describePackageVersion_domain - The name of the domain that contains the repository that contains the package version.

$sel:repository:DescribePackageVersion', describePackageVersion_repository - The name of the repository that contains the package version.

$sel:format:DescribePackageVersion', describePackageVersion_format - A format that specifies the type of the requested package version. The valid values are:

  • npm
  • pypi
  • maven

$sel:package:DescribePackageVersion', describePackageVersion_package - The name of the requested package version.

$sel:packageVersion:DescribePackageVersion', describePackageVersion_packageVersion - A string that contains the package version (for example, 3.5.2).

Request Lenses

describePackageVersion_namespace :: Lens' DescribePackageVersion (Maybe Text) Source #

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

  • The namespace of a Maven package is its groupId.
  • The namespace of an npm package is its scope.
  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

describePackageVersion_domainOwner :: Lens' DescribePackageVersion (Maybe Text) Source #

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

describePackageVersion_domain :: Lens' DescribePackageVersion Text Source #

The name of the domain that contains the repository that contains the package version.

describePackageVersion_repository :: Lens' DescribePackageVersion Text Source #

The name of the repository that contains the package version.

describePackageVersion_format :: Lens' DescribePackageVersion PackageFormat Source #

A format that specifies the type of the requested package version. The valid values are:

  • npm
  • pypi
  • maven

describePackageVersion_package :: Lens' DescribePackageVersion Text Source #

The name of the requested package version.

describePackageVersion_packageVersion :: Lens' DescribePackageVersion Text Source #

A string that contains the package version (for example, 3.5.2).

Destructuring the Response

data DescribePackageVersionResponse Source #

See: newDescribePackageVersionResponse smart constructor.

Constructors

DescribePackageVersionResponse' 

Fields

Instances

Instances details
Eq DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Read DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Show DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Generic DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

Associated Types

type Rep DescribePackageVersionResponse :: Type -> Type #

NFData DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

type Rep DescribePackageVersionResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.DescribePackageVersion

type Rep DescribePackageVersionResponse = D1 ('MetaData "DescribePackageVersionResponse" "Amazonka.CodeArtifact.DescribePackageVersion" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "DescribePackageVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "packageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageVersionDescription)))

newDescribePackageVersionResponse Source #

Create a value of DescribePackageVersionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribePackageVersionResponse', describePackageVersionResponse_httpStatus - The response's http status code.

$sel:packageVersion:DescribePackageVersion', describePackageVersionResponse_packageVersion - A PackageVersionDescription object that contains information about the requested package version.

Response Lenses