amazonka-codeartifact-2.0: Amazon CodeArtifact SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeArtifact.Types.PackageVersionDescription

Description

 
Synopsis

Documentation

data PackageVersionDescription Source #

Details about a package version.

See: newPackageVersionDescription smart constructor.

Constructors

PackageVersionDescription' 

Fields

  • displayName :: Maybe Text

    The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

  • format :: Maybe PackageFormat

    The format of the package version.

  • homePage :: Maybe Text

    The homepage associated with the package.

  • licenses :: Maybe [LicenseInfo]

    Information about licenses associated with the package version.

  • namespace :: Maybe Text

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

    • The namespace of a Maven package version is its groupId.
    • The namespace of an npm package version is its scope.
    • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  • origin :: Maybe PackageVersionOrigin

    A PackageVersionOrigin object that contains information about how the package version was added to the repository.

  • packageName :: Maybe Text

    The name of the requested package.

  • publishedTime :: Maybe POSIX

    A timestamp that contains the date and time the package version was published.

  • revision :: Maybe Text

    The revision of the package version.

  • sourceCodeRepository :: Maybe Text

    The repository for the source code in the package version, or the source code used to build it.

  • status :: Maybe PackageVersionStatus

    A string that contains the status of the package version.

  • summary :: Maybe Text

    A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

  • version :: Maybe Text

    The version of the package.

Instances

Instances details
FromJSON PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

parseJSON :: Value -> Parser PackageVersionDescription #

parseJSONList :: Value -> Parser [PackageVersionDescription] #

Generic PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Associated Types

type Rep PackageVersionDescription :: Type -> Type #

Methods

from :: PackageVersionDescription -> Rep PackageVersionDescription x #

to :: Rep PackageVersionDescription x -> PackageVersionDescription #

Read PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

readsPrec :: Int -> ReadS PackageVersionDescription #

readList :: ReadS [PackageVersionDescription] #

readPrec :: ReadPrec PackageVersionDescription #

readListPrec :: ReadPrec [PackageVersionDescription] #

Show PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

showsPrec :: Int -> PackageVersionDescription -> ShowS #

show :: PackageVersionDescription -> String #

showList :: [PackageVersionDescription] -> ShowS #

NFData PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

rnf :: PackageVersionDescription -> () #

Eq PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

(==) :: PackageVersionDescription -> PackageVersionDescription -> Bool #

(/=) :: PackageVersionDescription -> PackageVersionDescription -> Bool #

Hashable PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

Methods

hashWithSalt :: Int -> PackageVersionDescription -> Int #

hash :: PackageVersionDescription -> Int #

type Rep PackageVersionDescription Source # 
Instance details

Defined in Amazonka.CodeArtifact.Types.PackageVersionDescription

type Rep PackageVersionDescription = D1 ('MetaData "PackageVersionDescription" "Amazonka.CodeArtifact.Types.PackageVersionDescription" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PackageVersionDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat)) :*: S1 ('MetaSel ('Just "homePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "licenses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LicenseInfo])) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionOrigin))))) :*: ((S1 ('MetaSel ('Just "packageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "publishedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "sourceCodeRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionStatus))) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newPackageVersionDescription :: PackageVersionDescription Source #

Create a value of PackageVersionDescription 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:displayName:PackageVersionDescription', packageVersionDescription_displayName - The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

$sel:format:PackageVersionDescription', packageVersionDescription_format - The format of the package version.

$sel:homePage:PackageVersionDescription', packageVersionDescription_homePage - The homepage associated with the package.

$sel:licenses:PackageVersionDescription', packageVersionDescription_licenses - Information about licenses associated with the package version.

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

  • The namespace of a Maven package version is its groupId.
  • The namespace of an npm package version is its scope.
  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

$sel:origin:PackageVersionDescription', packageVersionDescription_origin - A PackageVersionOrigin object that contains information about how the package version was added to the repository.

$sel:packageName:PackageVersionDescription', packageVersionDescription_packageName - The name of the requested package.

$sel:publishedTime:PackageVersionDescription', packageVersionDescription_publishedTime - A timestamp that contains the date and time the package version was published.

$sel:revision:PackageVersionDescription', packageVersionDescription_revision - The revision of the package version.

$sel:sourceCodeRepository:PackageVersionDescription', packageVersionDescription_sourceCodeRepository - The repository for the source code in the package version, or the source code used to build it.

$sel:status:PackageVersionDescription', packageVersionDescription_status - A string that contains the status of the package version.

$sel:summary:PackageVersionDescription', packageVersionDescription_summary - A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

$sel:version:PackageVersionDescription', packageVersionDescription_version - The version of the package.

packageVersionDescription_displayName :: Lens' PackageVersionDescription (Maybe Text) Source #

The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

packageVersionDescription_format :: Lens' PackageVersionDescription (Maybe PackageFormat) Source #

The format of the package version.

packageVersionDescription_homePage :: Lens' PackageVersionDescription (Maybe Text) Source #

The homepage associated with the package.

packageVersionDescription_licenses :: Lens' PackageVersionDescription (Maybe [LicenseInfo]) Source #

Information about licenses associated with the package version.

packageVersionDescription_namespace :: Lens' PackageVersionDescription (Maybe Text) Source #

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

  • The namespace of a Maven package version is its groupId.
  • The namespace of an npm package version is its scope.
  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

packageVersionDescription_origin :: Lens' PackageVersionDescription (Maybe PackageVersionOrigin) Source #

A PackageVersionOrigin object that contains information about how the package version was added to the repository.

packageVersionDescription_packageName :: Lens' PackageVersionDescription (Maybe Text) Source #

The name of the requested package.

packageVersionDescription_publishedTime :: Lens' PackageVersionDescription (Maybe UTCTime) Source #

A timestamp that contains the date and time the package version was published.

packageVersionDescription_revision :: Lens' PackageVersionDescription (Maybe Text) Source #

The revision of the package version.

packageVersionDescription_sourceCodeRepository :: Lens' PackageVersionDescription (Maybe Text) Source #

The repository for the source code in the package version, or the source code used to build it.

packageVersionDescription_status :: Lens' PackageVersionDescription (Maybe PackageVersionStatus) Source #

A string that contains the status of the package version.

packageVersionDescription_summary :: Lens' PackageVersionDescription (Maybe Text) Source #

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

packageVersionDescription_version :: Lens' PackageVersionDescription (Maybe Text) Source #

The version of the package.