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 |
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
- data PutPackageOriginConfiguration = PutPackageOriginConfiguration' {}
- newPutPackageOriginConfiguration :: Text -> Text -> PackageFormat -> Text -> PackageOriginRestrictions -> PutPackageOriginConfiguration
- putPackageOriginConfiguration_domainOwner :: Lens' PutPackageOriginConfiguration (Maybe Text)
- putPackageOriginConfiguration_namespace :: Lens' PutPackageOriginConfiguration (Maybe Text)
- putPackageOriginConfiguration_domain :: Lens' PutPackageOriginConfiguration Text
- putPackageOriginConfiguration_repository :: Lens' PutPackageOriginConfiguration Text
- putPackageOriginConfiguration_format :: Lens' PutPackageOriginConfiguration PackageFormat
- putPackageOriginConfiguration_package :: Lens' PutPackageOriginConfiguration Text
- putPackageOriginConfiguration_restrictions :: Lens' PutPackageOriginConfiguration PackageOriginRestrictions
- data PutPackageOriginConfigurationResponse = PutPackageOriginConfigurationResponse' {}
- newPutPackageOriginConfigurationResponse :: Int -> PutPackageOriginConfigurationResponse
- putPackageOriginConfigurationResponse_originConfiguration :: Lens' PutPackageOriginConfigurationResponse (Maybe PackageOriginConfiguration)
- putPackageOriginConfigurationResponse_httpStatus :: Lens' PutPackageOriginConfigurationResponse Int
Creating a Request
data PutPackageOriginConfiguration Source #
See: newPutPackageOriginConfiguration
smart constructor.
PutPackageOriginConfiguration' | |
|
Instances
newPutPackageOriginConfiguration Source #
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.
PutPackageOriginConfigurationResponse' | |
|
Instances
newPutPackageOriginConfigurationResponse Source #
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.