ecluse:ecluse-runtime
Safe HaskellNone
LanguageGHC2021

Ecluse.Runtime.Maintenance.CodeArtifact.Decide.Internal

Description

CodeArtifact request construction, inventory parsing and maintenance decisions.

Synopsis

Coordinates

data CodeArtifactStore Source #

Vetted repository coordinates and native format from the composition root.

Constructors

CodeArtifactStore 

Fields

codeArtifactFormat :: Ecosystem -> Maybe CodeArtifactFormat Source #

The format CodeArtifact addresses an ecosystem by, Nothing where it has none.

formatEcosystem :: CodeArtifactFormat -> Ecosystem Source #

The ecosystem a format was built from.

formatToken :: CodeArtifactFormat -> Text Source #

Native format token and first segment of the repository endpoint.

What the backend does

codeArtifactFacts :: NameAlphabet -> CodeArtifactStore -> StoreFacts Source #

Deletion completes on response and permits later refill, under the ecosystem's name alphabet.

deleteCeiling :: DeleteCeiling Source #

The most versions one DeletePackageVersions call accepts.

listPageLimit :: Natural Source #

The largest maxResults the list calls accept. AWS documents no default page size.

Native coordinates

packageCoordinates :: PackageName -> (Maybe Text, Text) Source #

Native coordinates, with an npm scope represented as a namespace without its sigil.

packageNameFrom :: Ecosystem -> Maybe Text -> Text -> Either StoreFault PackageName Source #

Parse native listing identities and refuse namespaces for formats that do not have them.

Requests

listPackagesRequest :: CodeArtifactStore -> NamePrefix -> Maybe Text -> ListPackages Source #

List one bucket page. The prefix filters the package component, never its namespace.

listVersionsRequest :: CodeArtifactStore -> PackageName -> Maybe Text -> ListPackageVersions Source #

List one page of a package's versions, continuing from a page token when there is one.

listVersionsResult :: Either Error ListPackageVersionsResponse -> Either StoreFault ListPackageVersionsResponse Source #

A missing package has an empty local inventory. Other service faults retain their retry advice.

deleteRequest :: CodeArtifactStore -> PackageName -> [Version] -> DeletePackageVersions Source #

Physically delete a batch already bounded by deleteCeiling, requiring Published status.

describeRepositoryRequest :: CodeArtifactStore -> DescribeRepository Source #

Describe the repository, which carries both its ARN and its refill posture.

describeUpstreamRequest :: CodeArtifactStore -> RepositoryName -> DescribeRepository Source #

Describe another repository in the same domain, which is how the probe walks a chain.

listTagsRequest :: Text -> ListTagsForResource Source #

Read a repository's tags, which is where CodeArtifact carries the consent marker.

The walk cursor

cursorTagKey :: Ecosystem -> Text Source #

An ecosystem-specific cursor tag lets mounts share a repository without sharing their walk.

cursorTagRequest :: Ecosystem -> Text -> NamePrefix -> TagResource Source #

Record one completed bucket without replacing other repository tags.

cursorUntagRequest :: Ecosystem -> Text -> UntagResource Source #

Forget the walk, which a completed one does.

cursorOfTags :: NameAlphabet -> Ecosystem -> [Tag] -> Maybe NamePrefix Source #

Parse a cursor under the current alphabet, restarting when the stored prefix no longer fits.

Responses

packagesOfPage :: Ecosystem -> [PackageSummary] -> Either StoreFault [PackageName] Source #

Reject malformed native-grammar inventory. Other formats retain their absent-name filtering.

presenceOf :: PackageVersionStatus -> VersionPresence Source #

Published and Unlisted versions remain installable. Other statuses are withdrawn.

foldDeleteResponse :: [Version] -> DeletePackageVersionsResponse -> [(Version, VersionOutcome)] Source #

Give each submitted version one outcome, refusing absent or conflicting success evidence.

classifyRepository :: RepositoryDescription -> StoreClass Source #

Preserve repositories whose upstream or external connection can refill deleted versions.

repositoryOfStore :: CodeArtifactStore -> RepositoryName Source #

The repository a store's coordinates name, where a probe of its chain starts.

upstreamLinksOf :: RepositoryDescription -> RepositoryLinks Source #

Read external connections and upstream repositories, excluding unnamed entries.

consentOfTags :: [Tag] -> ConsentVerdict Source #

Whether a repository's tags carry the consent marker.

repositoryOfResponse :: DescribeRepositoryResponse -> Either StoreFault RepositoryDescription Source #

Require the optional repository description before classifying the store.

arnOfDescription :: RepositoryDescription -> Either StoreFault Text Source #

Require the repository ARN before reading or writing its tags.

Consent marker

consentTagKey :: Text Source #

The tag key that carries the operator's consent on CodeArtifact.

consentTagValue :: Text Source #

The value that key must hold for consent to count.

consentDescriptor :: Text Source #

How an operator attaches the marker, logged verbatim when consent is withheld.

Faults

classifyStoreFault :: Error -> StoreFault Source #

Classify an amazonka error for a maintenance call, refining the shared transport classification, which reports a throttle and a denied permission as the same fault.

describeUpstreamRefusal :: Error -> UpstreamSafety Source #

Read a failed probe read. An identity that may not ask cannot clear the repository, so its refusal is an unsafe answer rather than a fault, and every other failure leaves the question open.

describeRepositoryGrant :: PermissionName Source #

The grant the probe needs on the private upstream and on every repository in its chain.