Amazonka.CodeArtifact.ListPackageVersions

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.

This operation returns paginated results.

Creating a Request

data ListPackageVersions

See: newListPackageVersions smart constructor.

Constructors

ListPackageVersions'

Fields

• domainOwner :: Maybe Text

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

• maxResults :: Maybe Natural

  The maximum number of results to return per page.

• namespace :: Maybe Text

  The namespace of the package that contains the requested package versions. 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.
  • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
• nextToken :: Maybe Text

  The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

• originType :: Maybe PackageVersionOriginType

  The originType used to filter package versions. Only package versions with the provided originType will be returned.

• sortBy :: Maybe PackageVersionSortType

  How to sort the requested list of package versions.

• status :: Maybe PackageVersionStatus

  A string that filters the requested package versions by status.

• domain :: Text

  The name of the domain that contains the repository that contains the requested package versions.

• repository :: Text

  The name of the repository that contains the requested package versions.

• format :: PackageFormat

  The format of the returned package versions.

• package :: Text

  The name of the package for which you want to request package versions.

Instances

ToJSON ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

toJSON :: ListPackageVersions -> Value

toEncoding :: ListPackageVersions -> Encoding

toJSONList :: [ListPackageVersions] -> Value

toEncodingList :: [ListPackageVersions] -> Encoding

ToHeaders ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

toHeaders :: ListPackageVersions -> [Header]

ToPath ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

toPath :: ListPackageVersions -> ByteString

ToQuery ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

toQuery :: ListPackageVersions -> QueryString

AWSPager ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

page :: ListPackageVersions -> AWSResponse ListPackageVersions -> Maybe ListPackageVersions

AWSRequest ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Associated Types

type AWSResponse ListPackageVersions

Methods

request :: (Service -> Service) -> ListPackageVersions -> Request ListPackageVersions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPackageVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPackageVersions)))

Generic ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Associated Types

type Rep ListPackageVersions :: Type -> Type

Methods

from :: ListPackageVersions -> Rep ListPackageVersions x

to :: Rep ListPackageVersions x -> ListPackageVersions

Read ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

readsPrec :: Int -> ReadS ListPackageVersions

readList :: ReadS [ListPackageVersions]

readPrec :: ReadPrec ListPackageVersions

readListPrec :: ReadPrec [ListPackageVersions]

Show ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

showsPrec :: Int -> ListPackageVersions -> ShowS

show :: ListPackageVersions -> String

showList :: [ListPackageVersions] -> ShowS

NFData ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

rnf :: ListPackageVersions -> ()

Eq ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

(==) :: ListPackageVersions -> ListPackageVersions -> Bool

(/=) :: ListPackageVersions -> ListPackageVersions -> Bool

Hashable ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

hashWithSalt :: Int -> ListPackageVersions -> Int

hash :: ListPackageVersions -> Int

type AWSResponse ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

type AWSResponse ListPackageVersions = ListPackageVersionsResponse

type Rep ListPackageVersions

Defined in Amazonka.CodeArtifact.ListPackageVersions

type Rep ListPackageVersions = D1 ('MetaData "ListPackageVersions" "Amazonka.CodeArtifact.ListPackageVersions" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "ListPackageVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "originType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionOriginType))))) :*: ((S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionSortType)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionStatus)) :*: 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))))))

newListPackageVersions

Arguments

:: Text

$sel:domain:ListPackageVersions'

-> Text

$sel:repository:ListPackageVersions'

-> PackageFormat

ListPackageVersions

-> Text

ListPackageVersions

-> ListPackageVersions

Create a value of ListPackageVersions 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:

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

$sel:maxResults:ListPackageVersions', listPackageVersions_maxResults - The maximum number of results to return per page.

ListPackageVersions, listPackageVersions_namespace - The namespace of the package that contains the requested package versions. 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.
• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

ListPackageVersions, listPackageVersions_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListPackageVersions, listPackageVersions_originType - The originType used to filter package versions. Only package versions with the provided originType will be returned.

$sel:sortBy:ListPackageVersions', listPackageVersions_sortBy - How to sort the requested list of package versions.

ListPackageVersions, listPackageVersions_status - A string that filters the requested package versions by status.

$sel:domain:ListPackageVersions', listPackageVersions_domain - The name of the domain that contains the repository that contains the requested package versions.

$sel:repository:ListPackageVersions', listPackageVersions_repository - The name of the repository that contains the requested package versions.

ListPackageVersions, listPackageVersions_format - The format of the returned package versions.

ListPackageVersions, listPackageVersions_package - The name of the package for which you want to request package versions.

Request Lenses

listPackageVersions_domainOwner :: Lens' ListPackageVersions (Maybe Text)

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

listPackageVersions_maxResults :: Lens' ListPackageVersions (Maybe Natural)

The maximum number of results to return per page.

listPackageVersions_namespace :: Lens' ListPackageVersions (Maybe Text)

The namespace of the package that contains the requested package versions. 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.
• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

listPackageVersions_nextToken :: Lens' ListPackageVersions (Maybe Text)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listPackageVersions_originType :: Lens' ListPackageVersions (Maybe PackageVersionOriginType)

The originType used to filter package versions. Only package versions with the provided originType will be returned.

listPackageVersions_sortBy :: Lens' ListPackageVersions (Maybe PackageVersionSortType)

How to sort the requested list of package versions.

listPackageVersions_status :: Lens' ListPackageVersions (Maybe PackageVersionStatus)

A string that filters the requested package versions by status.

listPackageVersions_domain :: Lens' ListPackageVersions Text

The name of the domain that contains the repository that contains the requested package versions.

listPackageVersions_repository :: Lens' ListPackageVersions Text

The name of the repository that contains the requested package versions.

listPackageVersions_format :: Lens' ListPackageVersions PackageFormat

The format of the returned package versions.

listPackageVersions_package :: Lens' ListPackageVersions Text

The name of the package for which you want to request package versions.

Destructuring the Response

data ListPackageVersionsResponse

See: newListPackageVersionsResponse smart constructor.

Constructors

ListPackageVersionsResponse'

Fields

• defaultDisplayVersion :: Maybe Text

  The default package version to display. This depends on the package format:

  • For Maven and PyPI packages, it's the most recently published package version.
  • For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.
• format :: Maybe PackageFormat

  A format of the package.

• namespace :: Maybe Text

  The namespace of the package that contains the requested package versions. 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.
  • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
• nextToken :: Maybe Text

  If there are additional results, this is the token for the next set of results.

• package :: Maybe Text

  The name of the package.

• versions :: Maybe [PackageVersionSummary]

  The returned list of PackageVersionSummary objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

Associated Types

type Rep ListPackageVersionsResponse :: Type -> Type

Methods

from :: ListPackageVersionsResponse -> Rep ListPackageVersionsResponse x

to :: Rep ListPackageVersionsResponse x -> ListPackageVersionsResponse

Read ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

readsPrec :: Int -> ReadS ListPackageVersionsResponse

readList :: ReadS [ListPackageVersionsResponse]

readPrec :: ReadPrec ListPackageVersionsResponse

readListPrec :: ReadPrec [ListPackageVersionsResponse]

Show ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

showsPrec :: Int -> ListPackageVersionsResponse -> ShowS

show :: ListPackageVersionsResponse -> String

showList :: [ListPackageVersionsResponse] -> ShowS

NFData ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

rnf :: ListPackageVersionsResponse -> ()

Eq ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

Methods

(==) :: ListPackageVersionsResponse -> ListPackageVersionsResponse -> Bool

(/=) :: ListPackageVersionsResponse -> ListPackageVersionsResponse -> Bool

type Rep ListPackageVersionsResponse

Defined in Amazonka.CodeArtifact.ListPackageVersions

type Rep ListPackageVersionsResponse = D1 ('MetaData "ListPackageVersionsResponse" "Amazonka.CodeArtifact.ListPackageVersions" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "ListPackageVersionsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultDisplayVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat)) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PackageVersionSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListPackageVersionsResponse

Arguments

:: Int

$sel:httpStatus:ListPackageVersionsResponse'

-> ListPackageVersionsResponse

Create a value of ListPackageVersionsResponse 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:defaultDisplayVersion:ListPackageVersionsResponse', listPackageVersionsResponse_defaultDisplayVersion - The default package version to display. This depends on the package format:

• For Maven and PyPI packages, it's the most recently published package version.
• For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.

ListPackageVersions, listPackageVersionsResponse_format - A format of the package.

ListPackageVersions, listPackageVersionsResponse_namespace - The namespace of the package that contains the requested package versions. 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.
• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

ListPackageVersions, listPackageVersionsResponse_nextToken - If there are additional results, this is the token for the next set of results.

ListPackageVersions, listPackageVersionsResponse_package - The name of the package.

$sel:versions:ListPackageVersionsResponse', listPackageVersionsResponse_versions - The returned list of PackageVersionSummary objects.

$sel:httpStatus:ListPackageVersionsResponse', listPackageVersionsResponse_httpStatus - The response's http status code.

Response Lenses

listPackageVersionsResponse_defaultDisplayVersion :: Lens' ListPackageVersionsResponse (Maybe Text)

The default package version to display. This depends on the package format:

• For Maven and PyPI packages, it's the most recently published package version.
• For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.

listPackageVersionsResponse_format :: Lens' ListPackageVersionsResponse (Maybe PackageFormat)

A format of the package.

listPackageVersionsResponse_namespace :: Lens' ListPackageVersionsResponse (Maybe Text)

The namespace of the package that contains the requested package versions. 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.
• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

listPackageVersionsResponse_nextToken :: Lens' ListPackageVersionsResponse (Maybe Text)

If there are additional results, this is the token for the next set of results.

listPackageVersionsResponse_package :: Lens' ListPackageVersionsResponse (Maybe Text)

The name of the package.

listPackageVersionsResponse_versions :: Lens' ListPackageVersionsResponse (Maybe [PackageVersionSummary])

The returned list of PackageVersionSummary objects.

listPackageVersionsResponse_httpStatus :: Lens' ListPackageVersionsResponse Int

The response's http status code.