pub struct Client { /* private fields */ }
Expand description
Client for CodeArtifact
Client for invoking operations on CodeArtifact. Each operation on CodeArtifact is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_codeartifact::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_codeartifact::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AssociateExternalConnection
operation has
a Client::associate_external_connection
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.associate_external_connection()
.domain("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn associate_external_connection(
&self,
) -> AssociateExternalConnectionFluentBuilder
pub fn associate_external_connection( &self, ) -> AssociateExternalConnectionFluentBuilder
Constructs a fluent builder for the AssociateExternalConnection
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository to which the external connection is added.
external_connection(impl Into<String>)
/set_external_connection(Option<String>)
:
required: trueThe name of the external connection to add to the repository. The following values are supported:
-
public:npmjs
- for the npm public repository. -
public:nuget-org
- for the NuGet Gallery. -
public:pypi
- for the Python Package Index. -
public:maven-central
- for Maven Central. -
public:maven-googleandroid
- for the Google Android repository. -
public:maven-gradleplugins
- for the Gradle plugins repository. -
public:maven-commonsware
- for the CommonsWare Android repository. -
public:maven-clojars
- for the Clojars repository. -
public:ruby-gems-org
- for RubyGems.org. -
public:crates-io
- for Crates.io.
-
- On success, responds with
AssociateExternalConnectionOutput
with field(s):repository(Option<RepositoryDescription>)
:Information about the connected repository after processing the request.
- On failure, responds with
SdkError<AssociateExternalConnectionError>
Source§impl Client
impl Client
Sourcepub fn copy_package_versions(&self) -> CopyPackageVersionsFluentBuilder
pub fn copy_package_versions(&self) -> CopyPackageVersionsFluentBuilder
Constructs a fluent builder for the CopyPackageVersions
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the source and destination repositories.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
source_repository(impl Into<String>)
/set_source_repository(Option<String>)
:
required: trueThe name of the repository that contains the package versions to be copied.
destination_repository(impl Into<String>)
/set_destination_repository(Option<String>)
:
required: trueThe name of the repository into which package versions are copied.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package versions to be copied.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:
The namespace is required when copying package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package that contains the versions to be copied.
versions(impl Into<String>)
/set_versions(Option<Vec::<String>>)
:
required: falseThe versions of the package to be copied.
You must specify
versions
orversionRevisions
. You cannot specify both.version_revisions(impl Into<String>, impl Into<String>)
/set_version_revisions(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs. The keys are package versions and the values are package version revisions. A
CopyPackageVersion
operation succeeds if the specified versions in the source repository match the specified package version revision.You must specify
versions
orversionRevisions
. You cannot specify both.allow_overwrite(bool)
/set_allow_overwrite(Option<bool>)
:
required: falseSet to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the
failedVersions
field of the response with anALREADY_EXISTS
error code.include_from_upstream(bool)
/set_include_from_upstream(Option<bool>)
:
required: falseSet to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.
- On success, responds with
CopyPackageVersionsOutput
with field(s):successful_versions(Option<HashMap::<String, SuccessfulPackageVersionInfo>>)
:A list of the package versions that were successfully copied to your repository.
failed_versions(Option<HashMap::<String, PackageVersionError>>)
:A map of package versions that failed to copy and their error codes. The possible error codes are in the
PackageVersionError
data type. They are:-
ALREADY_EXISTS
-
MISMATCHED_REVISION
-
MISMATCHED_STATUS
-
NOT_ALLOWED
-
NOT_FOUND
-
SKIPPED
-
- On failure, responds with
SdkError<CopyPackageVersionsError>
Source§impl Client
impl Client
Sourcepub fn create_domain(&self) -> CreateDomainFluentBuilder
pub fn create_domain(&self) -> CreateDomainFluentBuilder
Constructs a fluent builder for the CreateDomain
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
encryption_key(impl Into<String>)
/set_encryption_key(Option<String>)
:
required: falseThe encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an
encryptionKey
, your IAM role must havekms:DescribeKey
andkms:CreateGrant
permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide.CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tag key-value pairs for the domain.
- On success, responds with
CreateDomainOutput
with field(s):domain(Option<DomainDescription>)
:Contains information about the created domain after processing the request.
- On failure, responds with
SdkError<CreateDomainError>
Source§impl Client
impl Client
Sourcepub fn create_package_group(&self) -> CreatePackageGroupFluentBuilder
pub fn create_package_group(&self) -> CreatePackageGroupFluentBuilder
Constructs a fluent builder for the CreatePackageGroup
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain in which you want to create a package group.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group to create. The pattern is also the identifier of the package group.
contact_info(impl Into<String>)
/set_contact_info(Option<String>)
:
required: falseThe contact information for the created package group.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the package group.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tag key-value pairs for the package group.
- On success, responds with
CreatePackageGroupOutput
with field(s):package_group(Option<PackageGroupDescription>)
:Information about the created package group after processing the request.
- On failure, responds with
SdkError<CreatePackageGroupError>
Source§impl Client
impl Client
Sourcepub fn create_repository(&self) -> CreateRepositoryFluentBuilder
pub fn create_repository(&self) -> CreateRepositoryFluentBuilder
Constructs a fluent builder for the CreateRepository
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the created repository.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository to create.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the created repository.
upstreams(UpstreamRepository)
/set_upstreams(Option<Vec::<UpstreamRepository>>)
:
required: falseA list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseOne or more tag key-value pairs for the repository.
- On success, responds with
CreateRepositoryOutput
with field(s):repository(Option<RepositoryDescription>)
:Information about the created repository after processing the request.
- On failure, responds with
SdkError<CreateRepositoryError>
Source§impl Client
impl Client
Sourcepub fn delete_domain(&self) -> DeleteDomainFluentBuilder
pub fn delete_domain(&self) -> DeleteDomainFluentBuilder
Constructs a fluent builder for the DeleteDomain
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain to delete.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- On success, responds with
DeleteDomainOutput
with field(s):domain(Option<DomainDescription>)
:Contains information about the deleted domain after processing the request.
- On failure, responds with
SdkError<DeleteDomainError>
Source§impl Client
impl Client
Sourcepub fn delete_domain_permissions_policy(
&self,
) -> DeleteDomainPermissionsPolicyFluentBuilder
pub fn delete_domain_permissions_policy( &self, ) -> DeleteDomainPermissionsPolicyFluentBuilder
Constructs a fluent builder for the DeleteDomainPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain associated with the resource policy to be deleted.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
policy_revision(impl Into<String>)
/set_policy_revision(Option<String>)
:
required: falseThe current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain’s resource policy.
- On success, responds with
DeleteDomainPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:Information about the deleted resource policy after processing the request.
- On failure, responds with
SdkError<DeleteDomainPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_package(&self) -> DeletePackageFluentBuilder
pub fn delete_package(&self) -> DeletePackageFluentBuilder
Constructs a fluent builder for the DeletePackage
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package to delete.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package to delete.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the requested package to delete.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
The namespace is required when deleting packages of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package to delete.
- On success, responds with
DeletePackageOutput
with field(s):deleted_package(Option<PackageSummary>)
:Details about a package, including its format, namespace, and name.
- On failure, responds with
SdkError<DeletePackageError>
Source§impl Client
impl Client
Sourcepub fn delete_package_group(&self) -> DeletePackageGroupFluentBuilder
pub fn delete_package_group(&self) -> DeletePackageGroupFluentBuilder
Constructs a fluent builder for the DeletePackageGroup
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe domain that contains the package group to be deleted.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group to be deleted.
- On success, responds with
DeletePackageGroupOutput
with field(s):package_group(Option<PackageGroupDescription>)
:Information about the deleted package group after processing the request.
- On failure, responds with
SdkError<DeletePackageGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_package_versions(&self) -> DeletePackageVersionsFluentBuilder
pub fn delete_package_versions(&self) -> DeletePackageVersionsFluentBuilder
Constructs a fluent builder for the DeletePackageVersions
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package to delete.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package versions to delete.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package versions to delete.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:
The namespace is required when deleting package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package with the versions to delete.
versions(impl Into<String>)
/set_versions(Option<Vec::<String>>)
:
required: trueAn array of strings that specify the versions of the package to delete.
expected_status(PackageVersionStatus)
/set_expected_status(Option<PackageVersionStatus>)
:
required: falseThe expected status of the package version to delete.
- On success, responds with
DeletePackageVersionsOutput
with field(s):successful_versions(Option<HashMap::<String, SuccessfulPackageVersionInfo>>)
:A list of the package versions that were successfully deleted. The status of every successful version will be
Deleted
.failed_versions(Option<HashMap::<String, PackageVersionError>>)
:A
PackageVersionError
object that contains a map of errors codes for the deleted package that failed. The possible error codes are:-
ALREADY_EXISTS
-
MISMATCHED_REVISION
-
MISMATCHED_STATUS
-
NOT_ALLOWED
-
NOT_FOUND
-
SKIPPED
-
- On failure, responds with
SdkError<DeletePackageVersionsError>
Source§impl Client
impl Client
Sourcepub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder
pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder
Constructs a fluent builder for the DeleteRepository
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository to delete.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository to delete.
- On success, responds with
DeleteRepositoryOutput
with field(s):repository(Option<RepositoryDescription>)
:Information about the deleted repository after processing the request.
- On failure, responds with
SdkError<DeleteRepositoryError>
Source§impl Client
impl Client
Sourcepub fn delete_repository_permissions_policy(
&self,
) -> DeleteRepositoryPermissionsPolicyFluentBuilder
pub fn delete_repository_permissions_policy( &self, ) -> DeleteRepositoryPermissionsPolicyFluentBuilder
Constructs a fluent builder for the DeleteRepositoryPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository associated with the resource policy to be deleted.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that is associated with the resource policy to be deleted
policy_revision(impl Into<String>)
/set_policy_revision(Option<String>)
:
required: falseThe revision of the repository’s resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository’s resource policy.
- On success, responds with
DeleteRepositoryPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:Information about the deleted policy after processing the request.
- On failure, responds with
SdkError<DeleteRepositoryPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn describe_domain(&self) -> DescribeDomainFluentBuilder
pub fn describe_domain(&self) -> DescribeDomainFluentBuilder
Constructs a fluent builder for the DescribeDomain
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueA string that specifies the name of the requested domain.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- On success, responds with
DescribeDomainOutput
with field(s):domain(Option<DomainDescription>)
:Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.
- On failure, responds with
SdkError<DescribeDomainError>
Source§impl Client
impl Client
Sourcepub fn describe_package(&self) -> DescribePackageFluentBuilder
pub fn describe_package(&self) -> DescribePackageFluentBuilder
Constructs a fluent builder for the DescribePackage
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the requested package.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the requested package.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting packages of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the requested package.
- On success, responds with
DescribePackageOutput
with field(s):package(Option<PackageDescription>)
:A PackageDescription object that contains information about the requested package.
- On failure, responds with
SdkError<DescribePackageError>
Source§impl Client
impl Client
Sourcepub fn describe_package_group(&self) -> DescribePackageGroupFluentBuilder
pub fn describe_package_group(&self) -> DescribePackageGroupFluentBuilder
Constructs a fluent builder for the DescribePackageGroup
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package group.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the requested package group.
- On success, responds with
DescribePackageGroupOutput
with field(s):package_group(Option<PackageGroupDescription>)
:A PackageGroupDescription object that contains information about the requested package group.
- On failure, responds with
SdkError<DescribePackageGroupError>
Source§impl Client
impl Client
Sourcepub fn describe_package_version(&self) -> DescribePackageVersionFluentBuilder
pub fn describe_package_version(&self) -> DescribePackageVersionFluentBuilder
Constructs a fluent builder for the DescribePackageVersion
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package version.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package version.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the requested package version.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the requested package version.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA string that contains the package version (for example,
3.5.2
).
- On success, responds with
DescribePackageVersionOutput
with field(s):package_version(Option<PackageVersionDescription>)
:A PackageVersionDescription object that contains information about the requested package version.
- On failure, responds with
SdkError<DescribePackageVersionError>
Source§impl Client
impl Client
Sourcepub fn describe_repository(&self) -> DescribeRepositoryFluentBuilder
pub fn describe_repository(&self) -> DescribeRepositoryFluentBuilder
Constructs a fluent builder for the DescribeRepository
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository to describe.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueA string that specifies the name of the requested repository.
- On success, responds with
DescribeRepositoryOutput
with field(s):repository(Option<RepositoryDescription>)
:A
RepositoryDescription
object that contains the requested repository information.
- On failure, responds with
SdkError<DescribeRepositoryError>
Source§impl Client
impl Client
Sourcepub fn disassociate_external_connection(
&self,
) -> DisassociateExternalConnectionFluentBuilder
pub fn disassociate_external_connection( &self, ) -> DisassociateExternalConnectionFluentBuilder
Constructs a fluent builder for the DisassociateExternalConnection
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository from which to remove the external repository.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository from which the external connection will be removed.
external_connection(impl Into<String>)
/set_external_connection(Option<String>)
:
required: trueThe name of the external connection to be removed from the repository.
- On success, responds with
DisassociateExternalConnectionOutput
with field(s):repository(Option<RepositoryDescription>)
:The repository associated with the removed external connection.
- On failure, responds with
SdkError<DisassociateExternalConnectionError>
Source§impl Client
impl Client
Sourcepub fn dispose_package_versions(&self) -> DisposePackageVersionsFluentBuilder
pub fn dispose_package_versions(&self) -> DisposePackageVersionsFluentBuilder
Constructs a fluent builder for the DisposePackageVersions
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository you want to dispose.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package versions you want to dispose.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of package versions you want to dispose.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:
The namespace is required when disposing package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package with the versions you want to dispose.
versions(impl Into<String>)
/set_versions(Option<Vec::<String>>)
:
required: trueThe versions of the package you want to dispose.
version_revisions(impl Into<String>, impl Into<String>)
/set_version_revisions(Option<HashMap::<String, String>>)
:
required: falseThe revisions of the package versions you want to dispose.
expected_status(PackageVersionStatus)
/set_expected_status(Option<PackageVersionStatus>)
:
required: falseThe expected status of the package version to dispose.
- On success, responds with
DisposePackageVersionsOutput
with field(s):successful_versions(Option<HashMap::<String, SuccessfulPackageVersionInfo>>)
:A list of the package versions that were successfully disposed.
failed_versions(Option<HashMap::<String, PackageVersionError>>)
:A
PackageVersionError
object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:-
ALREADY_EXISTS
-
MISMATCHED_REVISION
-
MISMATCHED_STATUS
-
NOT_ALLOWED
-
NOT_FOUND
-
SKIPPED
-
- On failure, responds with
SdkError<DisposePackageVersionsError>
Source§impl Client
impl Client
Sourcepub fn get_associated_package_group(
&self,
) -> GetAssociatedPackageGroupFluentBuilder
pub fn get_associated_package_group( &self, ) -> GetAssociatedPackageGroupFluentBuilder
Constructs a fluent builder for the GetAssociatedPackageGroup
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package from which to get the associated package group.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package from which to get the associated package group.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:
The namespace is required when getting associated package groups from packages of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe package from which to get the associated package group.
- On success, responds with
GetAssociatedPackageGroupOutput
with field(s):package_group(Option<PackageGroupDescription>)
:The package group that is associated with the requested package.
association_type(Option<PackageGroupAssociationType>)
:Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.
- On failure, responds with
SdkError<GetAssociatedPackageGroupError>
Source§impl Client
impl Client
Constructs a fluent builder for the GetAuthorizationToken
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that is in scope for the generated authorization token.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
duration_seconds(i64)
/set_duration_seconds(Option<i64>)
:
required: falseThe time, in seconds, that the generated authorization token is valid. Valid values are
0
and any number between900
(15 minutes) and43200
(12 hours). A value of0
will set the expiration of the authorization token to the same expiration of the user’s role’s temporary credentials.
- On success, responds with
GetAuthorizationTokenOutput
with field(s):authorization_token(Option<String>)
:The returned authentication token.
expiration(Option<DateTime>)
:A timestamp that specifies the date and time the authorization token expires.
- On failure, responds with
SdkError<GetAuthorizationTokenError>
Source§impl Client
impl Client
Sourcepub fn get_domain_permissions_policy(
&self,
) -> GetDomainPermissionsPolicyFluentBuilder
pub fn get_domain_permissions_policy( &self, ) -> GetDomainPermissionsPolicyFluentBuilder
Constructs a fluent builder for the GetDomainPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain to which the resource policy is attached.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- On success, responds with
GetDomainPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:The returned resource policy.
- On failure, responds with
SdkError<GetDomainPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn get_package_version_asset(&self) -> GetPackageVersionAssetFluentBuilder
pub fn get_package_version_asset(&self) -> GetPackageVersionAssetFluentBuilder
Constructs a fluent builder for the GetPackageVersionAsset
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package version with the requested asset.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe repository that contains the package version with the requested asset.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the package version with the requested asset file.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting assets from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package that contains the requested asset.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA string that contains the package version (for example,
3.5.2
).asset(impl Into<String>)
/set_asset(Option<String>)
:
required: trueThe name of the requested asset.
package_version_revision(impl Into<String>)
/set_package_version_revision(Option<String>)
:
required: falseThe name of the package version revision that contains the requested asset.
- On success, responds with
GetPackageVersionAssetOutput
with field(s):asset(ByteStream)
:The binary file, or asset, that is downloaded.
asset_name(Option<String>)
:The name of the asset that is downloaded.
package_version(Option<String>)
:A string that contains the package version (for example,
3.5.2
).package_version_revision(Option<String>)
:The name of the package version revision that contains the downloaded asset.
- On failure, responds with
SdkError<GetPackageVersionAssetError>
Source§impl Client
impl Client
Sourcepub fn get_package_version_readme(&self) -> GetPackageVersionReadmeFluentBuilder
pub fn get_package_version_readme(&self) -> GetPackageVersionReadmeFluentBuilder
Constructs a fluent builder for the GetPackageVersionReadme
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package version with the requested readme file.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe repository that contains the package with the requested readme file.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the package version with the requested readme file.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting the readme from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package version that contains the requested readme file.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA string that contains the package version (for example,
3.5.2
).
- On success, responds with
GetPackageVersionReadmeOutput
with field(s):format(Option<PackageFormat>)
:The format of the package with the requested readme file.
namespace(Option<String>)
:The namespace of the package version with the requested readme file. The package 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 or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(Option<String>)
:The name of the package that contains the returned readme file.
version(Option<String>)
:The version of the package with the requested readme file.
version_revision(Option<String>)
:The current revision associated with the package version.
readme(Option<String>)
:The text of the returned readme file.
- On failure, responds with
SdkError<GetPackageVersionReadmeError>
Source§impl Client
impl Client
Sourcepub fn get_repository_endpoint(&self) -> GetRepositoryEndpointFluentBuilder
pub fn get_repository_endpoint(&self) -> GetRepositoryEndpointFluentBuilder
Constructs a fluent builder for the GetRepositoryEndpoint
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueReturns which endpoint of a repository to return. A repository has one endpoint for each package format.
endpoint_type(EndpointType)
/set_endpoint_type(Option<EndpointType>)
:
required: falseA string that specifies the type of endpoint.
- On success, responds with
GetRepositoryEndpointOutput
with field(s):repository_endpoint(Option<String>)
:A string that specifies the URL of the returned endpoint.
- On failure, responds with
SdkError<GetRepositoryEndpointError>
Source§impl Client
impl Client
Sourcepub fn get_repository_permissions_policy(
&self,
) -> GetRepositoryPermissionsPolicyFluentBuilder
pub fn get_repository_permissions_policy( &self, ) -> GetRepositoryPermissionsPolicyFluentBuilder
Constructs a fluent builder for the GetRepositoryPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain containing the repository whose associated resource policy is to be retrieved.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository whose associated resource policy is to be retrieved.
- On success, responds with
GetRepositoryPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:The returned resource policy.
- On failure, responds with
SdkError<GetRepositoryPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn list_allowed_repositories_for_group(
&self,
) -> ListAllowedRepositoriesForGroupFluentBuilder
pub fn list_allowed_repositories_for_group( &self, ) -> ListAllowedRepositoriesForGroupFluentBuilder
Constructs a fluent builder for the ListAllowedRepositoriesForGroup
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package group from which to list allowed repositories.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group from which to list allowed repositories.
origin_restriction_type(PackageGroupOriginRestrictionType)
/set_origin_restriction_type(Option<PackageGroupOriginRestrictionType>)
:
required: trueThe origin configuration restriction type of which to list allowed repositories.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListAllowedRepositoriesForGroupOutput
with field(s):allowed_repositories(Option<Vec::<String>>)
:The list of allowed repositories for the package group and origin configuration restriction type.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListAllowedRepositoriesForGroupError>
Source§impl Client
impl Client
Sourcepub fn list_associated_packages(&self) -> ListAssociatedPackagesFluentBuilder
pub fn list_associated_packages(&self) -> ListAssociatedPackagesFluentBuilder
Constructs a fluent builder for the ListAssociatedPackages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the package group from which to list associated packages.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group from which to list associated packages.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
preview(bool)
/set_preview(Option<bool>)
:
required: falseWhen this flag is included,
ListAssociatedPackages
will return a list of packages that would be associated with a package group, even if it does not exist.
- On success, responds with
ListAssociatedPackagesOutput
with field(s):packages(Option<Vec::<AssociatedPackage>>)
:The list of packages associated with the requested package group.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListAssociatedPackagesError>
Source§impl Client
impl Client
Sourcepub fn list_domains(&self) -> ListDomainsFluentBuilder
pub fn list_domains(&self) -> ListDomainsFluentBuilder
Constructs a fluent builder for the ListDomains
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListDomainsOutput
with field(s):domains(Option<Vec::<DomainSummary>>)
:The returned list of DomainSummary objects.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListDomainsError>
Source§impl Client
impl Client
Sourcepub fn list_package_groups(&self) -> ListPackageGroupsFluentBuilder
pub fn list_package_groups(&self) -> ListPackageGroupsFluentBuilder
Constructs a fluent builder for the ListPackageGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe domain for which you want to list package groups.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
prefix(impl Into<String>)
/set_prefix(Option<String>)
:
required: falseA prefix for which to search package groups. When included,
ListPackageGroups
will return only package groups with patterns that match the prefix.
- On success, responds with
ListPackageGroupsOutput
with field(s):package_groups(Option<Vec::<PackageGroupSummary>>)
:The list of package groups in the requested domain.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListPackageGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_package_version_assets(
&self,
) -> ListPackageVersionAssetsFluentBuilder
pub fn list_package_version_assets( &self, ) -> ListPackageVersionAssetsFluentBuilder
Constructs a fluent builder for the ListPackageVersionAssets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository associated with the package version assets.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package that contains the requested package version assets.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package that contains the requested package version assets.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:
The namespace is required requesting assets from package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package that contains the requested package version assets.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA string that contains the package version (for example,
3.5.2
).max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListPackageVersionAssetsOutput
with field(s):format(Option<PackageFormat>)
:The format of the package that contains the requested package version assets.
namespace(Option<String>)
:The namespace of the package version that contains the requested package version assets. The package 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 or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(Option<String>)
:The name of the package that contains the requested package version assets.
version(Option<String>)
:The version of the package associated with the requested assets.
version_revision(Option<String>)
:The current revision associated with the package version.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
assets(Option<Vec::<AssetSummary>>)
:The returned list of AssetSummary objects.
- On failure, responds with
SdkError<ListPackageVersionAssetsError>
Source§impl Client
impl Client
Sourcepub fn list_package_version_dependencies(
&self,
) -> ListPackageVersionDependenciesFluentBuilder
pub fn list_package_version_dependencies( &self, ) -> ListPackageVersionDependenciesFluentBuilder
Constructs a fluent builder for the ListPackageVersionDependencies
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the requested package version dependencies.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the requested package version.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package with the requested dependencies.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:
The namespace is required when listing dependencies from package versions of the following formats:
-
Maven
-
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.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package versions’ package.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA string that contains the package version (for example,
3.5.2
).next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListPackageVersionDependenciesOutput
with field(s):format(Option<PackageFormat>)
:A format that specifies the type of the package that contains the returned dependencies.
namespace(Option<String>)
:The namespace of the package version that contains the returned dependencies. The package component that specifies its namespace depends on its type. For example:
The namespace is required when listing dependencies from package versions of the following formats:
-
Maven
-
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.
-
package(Option<String>)
:The name of the package that contains the returned package versions dependencies.
version(Option<String>)
:The version of the package that is specified in the request.
version_revision(Option<String>)
:The current revision associated with the package version.
next_token(Option<String>)
: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.
dependencies(Option<Vec::<PackageDependency>>)
:The returned list of PackageDependency objects.
- On failure, responds with
SdkError<ListPackageVersionDependenciesError>
Source§impl Client
impl Client
Sourcepub fn list_package_versions(&self) -> ListPackageVersionsFluentBuilder
pub fn list_package_versions(&self) -> ListPackageVersionsFluentBuilder
Constructs a fluent builder for the ListPackageVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the requested package versions.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the requested package versions.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueThe format of the package versions you want to list.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe 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 is required when deleting package versions of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package for which you want to request package versions.
status(PackageVersionStatus)
/set_status(Option<PackageVersionStatus>)
:
required: falseA string that filters the requested package versions by status.
sort_by(PackageVersionSortType)
/set_sort_by(Option<PackageVersionSortType>)
:
required: falseHow to sort the requested list of package versions.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
origin_type(PackageVersionOriginType)
/set_origin_type(Option<PackageVersionOriginType>)
:
required: falseThe
originType
used to filter package versions. Only package versions with the providedoriginType
will be returned.
- On success, responds with
ListPackageVersionsOutput
with field(s):default_display_version(Option<String>)
: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 thelatest
tag is not set, it’s the most recently published package version.
-
format(Option<PackageFormat>)
:A format of the package.
namespace(Option<String>)
: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 version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(Option<String>)
:The name of the package.
versions(Option<Vec::<PackageVersionSummary>>)
:The returned list of PackageVersionSummary objects.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListPackageVersionsError>
Source§impl Client
impl Client
Sourcepub fn list_packages(&self) -> ListPackagesFluentBuilder
pub fn list_packages(&self) -> ListPackagesFluentBuilder
Constructs a fluent builder for the ListPackages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the requested packages.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the requested packages.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: falseThe format used to filter requested packages. Only packages from the provided format will be returned.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called
–namespace
and not–namespace-prefix
, it has prefix-matching behavior.Each package format uses namespace as follows:
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package_prefix(impl Into<String>)
/set_package_prefix(Option<String>)
:
required: falseA prefix used to filter requested packages. Only packages with names that start with
packagePrefix
are returned.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
publish(AllowPublish)
/set_publish(Option<AllowPublish>)
:
required: falseThe value of the
Publish
package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.upstream(AllowUpstream)
/set_upstream(Option<AllowUpstream>)
:
required: falseThe value of the
Upstream
package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
- On success, responds with
ListPackagesOutput
with field(s):packages(Option<Vec::<PackageSummary>>)
:The list of returned PackageSummary objects.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListPackagesError>
Source§impl Client
impl Client
Sourcepub fn list_repositories(&self) -> ListRepositoriesFluentBuilder
pub fn list_repositories(&self) -> ListRepositoriesFluentBuilder
Constructs a fluent builder for the ListRepositories
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
repository_prefix(impl Into<String>)
/set_repository_prefix(Option<String>)
:
required: falseA prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefix
are returned.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListRepositoriesOutput
with field(s):repositories(Option<Vec::<RepositorySummary>>)
:The returned list of RepositorySummary objects.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListRepositoriesError>
Source§impl Client
impl Client
Sourcepub fn list_repositories_in_domain(
&self,
) -> ListRepositoriesInDomainFluentBuilder
pub fn list_repositories_in_domain( &self, ) -> ListRepositoriesInDomainFluentBuilder
Constructs a fluent builder for the ListRepositoriesInDomain
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the returned list of repositories.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
administrator_account(impl Into<String>)
/set_administrator_account(Option<String>)
:
required: falseFilter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
repository_prefix(impl Into<String>)
/set_repository_prefix(Option<String>)
:
required: falseA prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefix
are returned.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListRepositoriesInDomainOutput
with field(s):repositories(Option<Vec::<RepositorySummary>>)
:The returned list of repositories.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListRepositoriesInDomainError>
Source§impl Client
impl Client
Sourcepub fn list_sub_package_groups(&self) -> ListSubPackageGroupsFluentBuilder
pub fn list_sub_package_groups(&self) -> ListSubPackageGroupsFluentBuilder
Constructs a fluent builder for the ListSubPackageGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain which contains the package group from which to list sub package groups.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group from which to list sub package groups.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return per page.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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.
- On success, responds with
ListSubPackageGroupsOutput
with field(s):package_groups(Option<Vec::<PackageGroupSummary>>)
:A list of sub package groups for the requested package group.
next_token(Option<String>)
:If there are additional results, this is the token for the next set of results.
- On failure, responds with
SdkError<ListSubPackageGroupsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource to get tags for.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:A list of tag key and value pairs associated with the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn publish_package_version(&self) -> PublishPackageVersionFluentBuilder
pub fn publish_package_version(&self) -> PublishPackageVersionFluentBuilder
Constructs a fluent builder for the PublishPackageVersion
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package version to publish.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that the package version will be published to.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the package version with the requested asset file.
The only supported value is
generic
.namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version to publish.
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package version to publish.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueThe package version to publish (for example,
3.5.2
).asset_content(ByteStream)
/set_asset_content(ByteStream)
:
required: trueThe content of the asset to publish.
asset_name(impl Into<String>)
/set_asset_name(Option<String>)
:
required: trueThe name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters:
~ ! @ ^ & ( ) -
_ + \[ \] { } ; , .
asset_sha256(impl Into<String>)
/set_asset_sha256(Option<String>)
:
required: trueThe SHA256 hash of the
assetContent
to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).This value is used as an integrity check to verify that the
assetContent
has not changed after it was originally sent.unfinished(bool)
/set_unfinished(Option<bool>)
:
required: falseSpecifies whether the package version should remain in the
unfinished
state. If omitted, the package version status will be set toPublished
(see Package version status in the CodeArtifact User Guide).Valid values:
unfinished
- On success, responds with
PublishPackageVersionOutput
with field(s):format(Option<PackageFormat>)
:The format of the package version.
namespace(Option<String>)
:The namespace of the package version.
package(Option<String>)
:The name of the package.
version(Option<String>)
:The version of the package.
version_revision(Option<String>)
:The revision of the package version.
status(Option<PackageVersionStatus>)
:A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.
asset(Option<AssetSummary>)
:An AssetSummary for the published asset.
- On failure, responds with
SdkError<PublishPackageVersionError>
Source§impl Client
impl Client
Sourcepub fn put_domain_permissions_policy(
&self,
) -> PutDomainPermissionsPolicyFluentBuilder
pub fn put_domain_permissions_policy( &self, ) -> PutDomainPermissionsPolicyFluentBuilder
Constructs a fluent builder for the PutDomainPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain on which to set the resource policy.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
policy_revision(impl Into<String>)
/set_policy_revision(Option<String>)
:
required: falseThe current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain’s resource policy.
policy_document(impl Into<String>)
/set_policy_document(Option<String>)
:
required: trueA valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
- On success, responds with
PutDomainPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:The resource policy that was set after processing the request.
- On failure, responds with
SdkError<PutDomainPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn put_package_origin_configuration(
&self,
) -> PutPackageOriginConfigurationFluentBuilder
pub fn put_package_origin_configuration( &self, ) -> PutPackageOriginConfigurationFluentBuilder
Constructs a fluent builder for the PutPackageOriginConfiguration
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository that contains the package.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the package to be updated.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe 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 version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package to be updated.
restrictions(PackageOriginRestrictions)
/set_restrictions(Option<PackageOriginRestrictions>)
:
required: trueA PackageOriginRestrictions object that contains information about the
upstream
andpublish
package origin restrictions. Theupstream
restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. Thepublish
restriction determines if new package versions can be published directly to the repository.You must include both the desired
upstream
andpublish
restrictions.
- On success, responds with
PutPackageOriginConfigurationOutput
with field(s):origin_configuration(Option<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.
- On failure, responds with
SdkError<PutPackageOriginConfigurationError>
Source§impl Client
impl Client
Sourcepub fn put_repository_permissions_policy(
&self,
) -> PutRepositoryPermissionsPolicyFluentBuilder
pub fn put_repository_permissions_policy( &self, ) -> PutRepositoryPermissionsPolicyFluentBuilder
Constructs a fluent builder for the PutRepositoryPermissionsPolicy
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain containing the repository to set the resource policy on.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository to set the resource policy on.
policy_revision(impl Into<String>)
/set_policy_revision(Option<String>)
:
required: falseSets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository’s resource policy.
policy_document(impl Into<String>)
/set_policy_document(Option<String>)
:
required: trueA valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
- On success, responds with
PutRepositoryPermissionsPolicyOutput
with field(s):policy(Option<ResourcePolicy>)
:The resource policy that was set after processing the request.
- On failure, responds with
SdkError<PutRepositoryPermissionsPolicyError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueThe tags you want to modify or add to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource that you want to remove tags from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag key for each tag that you want to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_package_group(&self) -> UpdatePackageGroupFluentBuilder
pub fn update_package_group(&self) -> UpdatePackageGroupFluentBuilder
Constructs a fluent builder for the UpdatePackageGroup
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain which contains the package group to be updated.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group to be updated.
contact_info(impl Into<String>)
/set_contact_info(Option<String>)
:
required: falseContact information which you want to update the requested package group with.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description you want to update the requested package group with.
- On success, responds with
UpdatePackageGroupOutput
with field(s):package_group(Option<PackageGroupDescription>)
:The package group and information about it after the request has been processed.
- On failure, responds with
SdkError<UpdatePackageGroupError>
Source§impl Client
impl Client
Sourcepub fn update_package_group_origin_configuration(
&self,
) -> UpdatePackageGroupOriginConfigurationFluentBuilder
pub fn update_package_group_origin_configuration( &self, ) -> UpdatePackageGroupOriginConfigurationFluentBuilder
Constructs a fluent builder for the UpdatePackageGroupOriginConfiguration
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain which contains the package group for which to update the origin configuration.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
package_group(impl Into<String>)
/set_package_group(Option<String>)
:
required: trueThe pattern of the package group for which to update the origin configuration.
restrictions(PackageGroupOriginRestrictionType, PackageGroupOriginRestrictionMode)
/set_restrictions(Option<HashMap::<PackageGroupOriginRestrictionType, PackageGroupOriginRestrictionMode>>)
:
required: falseThe origin configuration settings that determine how package versions can enter repositories.
add_allowed_repositories(PackageGroupAllowedRepository)
/set_add_allowed_repositories(Option<Vec::<PackageGroupAllowedRepository>>)
:
required: falseThe repository name and restrictions to add to the allowed repository list of the specified package group.
remove_allowed_repositories(PackageGroupAllowedRepository)
/set_remove_allowed_repositories(Option<Vec::<PackageGroupAllowedRepository>>)
:
required: falseThe repository name and restrictions to remove from the allowed repository list of the specified package group.
- On success, responds with
UpdatePackageGroupOriginConfigurationOutput
with field(s):package_group(Option<PackageGroupDescription>)
:The package group and information about it after processing the request.
allowed_repository_updates(Option<HashMap::<PackageGroupOriginRestrictionType, HashMap::<PackageGroupAllowedRepositoryUpdateType, Vec::<String>>>>)
:Information about the updated allowed repositories after processing the request.
- On failure, responds with
SdkError<UpdatePackageGroupOriginConfigurationError>
Source§impl Client
impl Client
Sourcepub fn update_package_versions_status(
&self,
) -> UpdatePackageVersionsStatusFluentBuilder
pub fn update_package_versions_status( &self, ) -> UpdatePackageVersionsStatusFluentBuilder
Constructs a fluent builder for the UpdatePackageVersionsStatus
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain that contains the repository that contains the package versions with a status to be updated.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe repository that contains the package versions with the status you want to update.
format(PackageFormat)
/set_format(Option<PackageFormat>)
:
required: trueA format that specifies the type of the package with the statuses to update.
namespace(impl Into<String>)
/set_namespace(Option<String>)
:
required: falseThe namespace of the package version to be updated. The package 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 or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
package(impl Into<String>)
/set_package(Option<String>)
:
required: trueThe name of the package with the version statuses to update.
versions(impl Into<String>)
/set_versions(Option<Vec::<String>>)
:
required: trueAn array of strings that specify the versions of the package with the statuses to update.
version_revisions(impl Into<String>, impl Into<String>)
/set_version_revisions(Option<HashMap::<String, String>>)
:
required: falseA map of package versions and package version revisions. The map
key
is the package version (for example,3.5.2
), and the mapvalue
is the package version revision.expected_status(PackageVersionStatus)
/set_expected_status(Option<PackageVersionStatus>)
:
required: falseThe package version’s expected status before it is updated. If
expectedStatus
is provided, the package version’s status is updated only if its status at the timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
.target_status(PackageVersionStatus)
/set_target_status(Option<PackageVersionStatus>)
:
required: trueThe status you want to change the package version status to.
- On success, responds with
UpdatePackageVersionsStatusOutput
with field(s):successful_versions(Option<HashMap::<String, SuccessfulPackageVersionInfo>>)
:A list of
PackageVersionError
objects, one for each package version with a status that failed to update.failed_versions(Option<HashMap::<String, PackageVersionError>>)
:A list of
SuccessfulPackageVersionInfo
objects, one for each package version with a status that successfully updated.
- On failure, responds with
SdkError<UpdatePackageVersionsStatusError>
Source§impl Client
impl Client
Sourcepub fn update_repository(&self) -> UpdateRepositoryFluentBuilder
pub fn update_repository(&self) -> UpdateRepositoryFluentBuilder
Constructs a fluent builder for the UpdateRepository
operation.
- The fluent builder is configurable:
domain(impl Into<String>)
/set_domain(Option<String>)
:
required: trueThe name of the domain associated with the repository to update.
domain_owner(impl Into<String>)
/set_domain_owner(Option<String>)
:
required: falseThe 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
repository(impl Into<String>)
/set_repository(Option<String>)
:
required: trueThe name of the repository to update.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseAn updated repository description.
upstreams(UpstreamRepository)
/set_upstreams(Option<Vec::<UpstreamRepository>>)
:
required: falseA list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
- On success, responds with
UpdateRepositoryOutput
with field(s):repository(Option<RepositoryDescription>)
:The updated repository.
- On failure, responds with
SdkError<UpdateRepositoryError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);