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.GetPackageVersionAsset

Description

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

Synopsis

Creating a Request

data GetPackageVersionAsset Source #

See: newGetPackageVersionAsset smart constructor.

Constructors

GetPackageVersionAsset' 

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.

  • packageVersionRevision :: Maybe Text

    The name of the package version revision that contains the requested asset.

  • domain :: Text

    The name of the domain that contains the repository that contains the package version with the requested asset.

  • repository :: Text

    The repository that contains the package version with the requested asset.

  • format :: PackageFormat

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

    • npm
    • pypi
    • maven
  • package :: Text

    The name of the package that contains the requested asset.

  • packageVersion :: Text

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

  • asset :: Text

    The name of the requested asset.

Instances

Instances details
Eq GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Read GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Show GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Generic GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Associated Types

type Rep GetPackageVersionAsset :: Type -> Type #

NFData GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Methods

rnf :: GetPackageVersionAsset -> () #

Hashable GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

AWSRequest GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Associated Types

type AWSResponse GetPackageVersionAsset #

ToHeaders GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

ToPath GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

ToQuery GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

type Rep GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

type Rep GetPackageVersionAsset = D1 ('MetaData "GetPackageVersionAsset" "Amazonka.CodeArtifact.GetPackageVersionAsset" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "GetPackageVersionAsset'" '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 "packageVersionRevision") '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) :*: S1 ('MetaSel ('Just "asset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse GetPackageVersionAsset Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

newGetPackageVersionAsset Source #

Create a value of GetPackageVersionAsset 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:GetPackageVersionAsset', getPackageVersionAsset_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:GetPackageVersionAsset', getPackageVersionAsset_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

$sel:packageVersionRevision:GetPackageVersionAsset', getPackageVersionAsset_packageVersionRevision - The name of the package version revision that contains the requested asset.

$sel:domain:GetPackageVersionAsset', getPackageVersionAsset_domain - The name of the domain that contains the repository that contains the package version with the requested asset.

$sel:repository:GetPackageVersionAsset', getPackageVersionAsset_repository - The repository that contains the package version with the requested asset.

$sel:format:GetPackageVersionAsset', getPackageVersionAsset_format - A format that specifies the type of the package version with the requested asset file. The valid values are:

  • npm
  • pypi
  • maven

$sel:package:GetPackageVersionAsset', getPackageVersionAsset_package - The name of the package that contains the requested asset.

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

$sel:asset:GetPackageVersionAsset', getPackageVersionAsset_asset - The name of the requested asset.

Request Lenses

getPackageVersionAsset_namespace :: Lens' GetPackageVersionAsset (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.

getPackageVersionAsset_domainOwner :: Lens' GetPackageVersionAsset (Maybe Text) Source #

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

getPackageVersionAsset_packageVersionRevision :: Lens' GetPackageVersionAsset (Maybe Text) Source #

The name of the package version revision that contains the requested asset.

getPackageVersionAsset_domain :: Lens' GetPackageVersionAsset Text Source #

The name of the domain that contains the repository that contains the package version with the requested asset.

getPackageVersionAsset_repository :: Lens' GetPackageVersionAsset Text Source #

The repository that contains the package version with the requested asset.

getPackageVersionAsset_format :: Lens' GetPackageVersionAsset PackageFormat Source #

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

  • npm
  • pypi
  • maven

getPackageVersionAsset_package :: Lens' GetPackageVersionAsset Text Source #

The name of the package that contains the requested asset.

getPackageVersionAsset_packageVersion :: Lens' GetPackageVersionAsset Text Source #

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

Destructuring the Response

data GetPackageVersionAssetResponse Source #

See: newGetPackageVersionAssetResponse smart constructor.

Constructors

GetPackageVersionAssetResponse' 

Fields

Instances

Instances details
Show GetPackageVersionAssetResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Generic GetPackageVersionAssetResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

Associated Types

type Rep GetPackageVersionAssetResponse :: Type -> Type #

type Rep GetPackageVersionAssetResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.GetPackageVersionAsset

type Rep GetPackageVersionAssetResponse = D1 ('MetaData "GetPackageVersionAssetResponse" "Amazonka.CodeArtifact.GetPackageVersionAsset" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "GetPackageVersionAssetResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "packageVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "packageVersionRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "asset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResponseBody)))))

newGetPackageVersionAssetResponse Source #

Create a value of GetPackageVersionAssetResponse 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:packageVersion:GetPackageVersionAsset', getPackageVersionAssetResponse_packageVersion - A string that contains the package version (for example, 3.5.2).

$sel:assetName:GetPackageVersionAssetResponse', getPackageVersionAssetResponse_assetName - The name of the asset that is downloaded.

$sel:packageVersionRevision:GetPackageVersionAsset', getPackageVersionAssetResponse_packageVersionRevision - The name of the package version revision that contains the downloaded asset.

$sel:httpStatus:GetPackageVersionAssetResponse', getPackageVersionAssetResponse_httpStatus - The response's http status code.

$sel:asset:GetPackageVersionAsset', getPackageVersionAssetResponse_asset - The binary file, or asset, that is downloaded.

Response Lenses

getPackageVersionAssetResponse_packageVersion :: Lens' GetPackageVersionAssetResponse (Maybe Text) Source #

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

getPackageVersionAssetResponse_packageVersionRevision :: Lens' GetPackageVersionAssetResponse (Maybe Text) Source #

The name of the package version revision that contains the downloaded asset.