Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeArtifact.PutPackageOriginConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the package origin configuration for a package.

The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.

PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

Synopsis

Creating a Request

data PutPackageOriginConfiguration Source #

See: newPutPackageOriginConfiguration smart constructor.

Constructors

PutPackageOriginConfiguration'

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.
namespace :: Maybe Text
The namespace of the package to be updated. 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.
domain :: Text
The name of the domain that contains the repository that contains the package.
repository :: Text
The name of the repository that contains the package.
format :: PackageFormat
A format that specifies the type of the package to be updated.
package :: Text
The name of the package to be updated.
restrictions :: PackageOriginRestrictions
A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.
You must include both the desired upstream and publish restrictions.

Instances

Instances details

ToJSON PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods toJSON :: PutPackageOriginConfiguration -> Value # toEncoding :: PutPackageOriginConfiguration -> Encoding # toJSONList :: [PutPackageOriginConfiguration] -> Value # toEncodingList :: [PutPackageOriginConfiguration] -> Encoding #
ToHeaders PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods toHeaders :: PutPackageOriginConfiguration -> [Header] #
ToPath PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods toPath :: PutPackageOriginConfiguration -> ByteString #
ToQuery PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods toQuery :: PutPackageOriginConfiguration -> QueryString #
AWSRequest PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Associated Types type AWSResponse PutPackageOriginConfiguration # Methods request :: (Service -> Service) -> PutPackageOriginConfiguration -> Request PutPackageOriginConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutPackageOriginConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutPackageOriginConfiguration))) #
Generic PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Associated Types type Rep PutPackageOriginConfiguration :: Type -> Type # Methods from :: PutPackageOriginConfiguration -> Rep PutPackageOriginConfiguration x # to :: Rep PutPackageOriginConfiguration x -> PutPackageOriginConfiguration #
Read PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods readsPrec :: Int -> ReadS PutPackageOriginConfiguration # readList :: ReadS [PutPackageOriginConfiguration] # readPrec :: ReadPrec PutPackageOriginConfiguration # readListPrec :: ReadPrec [PutPackageOriginConfiguration] #
Show PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods showsPrec :: Int -> PutPackageOriginConfiguration -> ShowS # show :: PutPackageOriginConfiguration -> String # showList :: [PutPackageOriginConfiguration] -> ShowS #
NFData PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods rnf :: PutPackageOriginConfiguration -> () #
Eq PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods (==) :: PutPackageOriginConfiguration -> PutPackageOriginConfiguration -> Bool # (/=) :: PutPackageOriginConfiguration -> PutPackageOriginConfiguration -> Bool #
Hashable PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods hashWithSalt :: Int -> PutPackageOriginConfiguration -> Int # hash :: PutPackageOriginConfiguration -> Int #
type AWSResponse PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration type AWSResponse PutPackageOriginConfiguration = PutPackageOriginConfigurationResponse
type Rep PutPackageOriginConfiguration Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration type Rep PutPackageOriginConfiguration = D1 ('MetaData "PutPackageOriginConfiguration" "Amazonka.CodeArtifact.PutPackageOriginConfiguration" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PutPackageOriginConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "namespace") '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 "restrictions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageOriginRestrictions)))))

newPutPackageOriginConfiguration Source #

Arguments

:: Text	`$sel:domain:PutPackageOriginConfiguration'`
-> Text	`$sel:repository:PutPackageOriginConfiguration'`
-> PackageFormat	`PutPackageOriginConfiguration`
-> Text	`PutPackageOriginConfiguration`
-> PackageOriginRestrictions	`PutPackageOriginConfiguration`
-> PutPackageOriginConfiguration

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

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

PutPackageOriginConfiguration, putPackageOriginConfiguration_namespace - The namespace of the package to be updated. 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.

$sel:domain:PutPackageOriginConfiguration', putPackageOriginConfiguration_domain - The name of the domain that contains the repository that contains the package.

$sel:repository:PutPackageOriginConfiguration', putPackageOriginConfiguration_repository - The name of the repository that contains the package.

PutPackageOriginConfiguration, putPackageOriginConfiguration_format - A format that specifies the type of the package to be updated.

PutPackageOriginConfiguration, putPackageOriginConfiguration_package - The name of the package to be updated.

PutPackageOriginConfiguration, putPackageOriginConfiguration_restrictions - A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.

You must include both the desired upstream and publish restrictions.

Request Lenses

putPackageOriginConfiguration_domainOwner :: Lens' PutPackageOriginConfiguration (Maybe Text) Source #

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

putPackageOriginConfiguration_namespace :: Lens' PutPackageOriginConfiguration (Maybe Text) Source #

The namespace of the package to be updated. 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.

putPackageOriginConfiguration_domain :: Lens' PutPackageOriginConfiguration Text Source #

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

putPackageOriginConfiguration_repository :: Lens' PutPackageOriginConfiguration Text Source #

The name of the repository that contains the package.

putPackageOriginConfiguration_format :: Lens' PutPackageOriginConfiguration PackageFormat Source #

A format that specifies the type of the package to be updated.

putPackageOriginConfiguration_package :: Lens' PutPackageOriginConfiguration Text Source #

The name of the package to be updated.

putPackageOriginConfiguration_restrictions :: Lens' PutPackageOriginConfiguration PackageOriginRestrictions Source #

A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository.

You must include both the desired upstream and publish restrictions.

Destructuring the Response

data PutPackageOriginConfigurationResponse Source #

See: newPutPackageOriginConfigurationResponse smart constructor.

Constructors

PutPackageOriginConfigurationResponse'
Fields originConfiguration :: Maybe PackageOriginConfiguration A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Associated Types type Rep PutPackageOriginConfigurationResponse :: Type -> Type # Methods from :: PutPackageOriginConfigurationResponse -> Rep PutPackageOriginConfigurationResponse x # to :: Rep PutPackageOriginConfigurationResponse x -> PutPackageOriginConfigurationResponse #
Read PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods readsPrec :: Int -> ReadS PutPackageOriginConfigurationResponse # readList :: ReadS [PutPackageOriginConfigurationResponse] # readPrec :: ReadPrec PutPackageOriginConfigurationResponse # readListPrec :: ReadPrec [PutPackageOriginConfigurationResponse] #
Show PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods showsPrec :: Int -> PutPackageOriginConfigurationResponse -> ShowS # show :: PutPackageOriginConfigurationResponse -> String # showList :: [PutPackageOriginConfigurationResponse] -> ShowS #
NFData PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods rnf :: PutPackageOriginConfigurationResponse -> () #
Eq PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration Methods (==) :: PutPackageOriginConfigurationResponse -> PutPackageOriginConfigurationResponse -> Bool # (/=) :: PutPackageOriginConfigurationResponse -> PutPackageOriginConfigurationResponse -> Bool #
type Rep PutPackageOriginConfigurationResponse Source #
Instance details Defined in Amazonka.CodeArtifact.PutPackageOriginConfiguration type Rep PutPackageOriginConfigurationResponse = D1 ('MetaData "PutPackageOriginConfigurationResponse" "Amazonka.CodeArtifact.PutPackageOriginConfiguration" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PutPackageOriginConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "originConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageOriginConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutPackageOriginConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutPackageOriginConfigurationResponse'`
-> PutPackageOriginConfigurationResponse

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

PutPackageOriginConfigurationResponse, putPackageOriginConfigurationResponse_originConfiguration - A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.

$sel:httpStatus:PutPackageOriginConfigurationResponse', putPackageOriginConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

putPackageOriginConfigurationResponse_originConfiguration :: Lens' PutPackageOriginConfigurationResponse (Maybe PackageOriginConfiguration) Source #

A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.

putPackageOriginConfigurationResponse_httpStatus :: Lens' PutPackageOriginConfigurationResponse Int Source #

The response's http status code.