pub struct Client { /* private fields */ }
Expand description
Client for AWS Signer
Client for invoking operations on AWS Signer. Each operation on AWS Signer 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_signer::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_signer::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 AddProfilePermission
operation has
a Client::add_profile_permission
, 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.add_profile_permission()
.profile_name("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.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
Source§impl Client
impl Client
Sourcepub fn add_profile_permission(&self) -> AddProfilePermissionFluentBuilder
pub fn add_profile_permission(&self) -> AddProfilePermissionFluentBuilder
Constructs a fluent builder for the AddProfilePermission
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe human-readable name of the signing profile.
profile_version(impl Into<String>)
/set_profile_version(Option<String>)
:
required: falseThe version of the signing profile.
action(impl Into<String>)
/set_action(Option<String>)
:
required: trueFor cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API’s operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.
You can designate the following actions to an account.
-
signer:StartSigningJob
. This action isn’t supported for container image workflows. For details, seeStartSigningJob
. -
signer:SignPayload
. This action isn’t supported for AWS Lambda workflows. For details, seeSignPayload
-
signer:GetSigningProfile
. For details, seeGetSigningProfile
. -
signer:RevokeSignature
. For details, seeRevokeSignature
.
-
principal(impl Into<String>)
/set_principal(Option<String>)
:
required: trueThe AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: falseA unique identifier for the current profile revision.
statement_id(impl Into<String>)
/set_statement_id(Option<String>)
:
required: trueA unique identifier for the cross-account permission statement.
- On success, responds with
AddProfilePermissionOutput
with field(s):revision_id(Option<String>)
:A unique identifier for the current profile revision.
- On failure, responds with
SdkError<AddProfilePermissionError>
Source§impl Client
impl Client
Sourcepub fn cancel_signing_profile(&self) -> CancelSigningProfileFluentBuilder
pub fn cancel_signing_profile(&self) -> CancelSigningProfileFluentBuilder
Constructs a fluent builder for the CancelSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the signing profile to be canceled.
- On success, responds with
CancelSigningProfileOutput
- On failure, responds with
SdkError<CancelSigningProfileError>
Source§impl Client
impl Client
Sourcepub fn describe_signing_job(&self) -> DescribeSigningJobFluentBuilder
pub fn describe_signing_job(&self) -> DescribeSigningJobFluentBuilder
Constructs a fluent builder for the DescribeSigningJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe ID of the signing job on input.
- On success, responds with
DescribeSigningJobOutput
with field(s):job_id(Option<String>)
:The ID of the signing job on output.
source(Option<Source>)
:The object that contains the name of your S3 bucket or your raw code.
signing_material(Option<SigningMaterial>)
:The Amazon Resource Name (ARN) of your code signing certificate.
platform_id(Option<String>)
:The microcontroller platform to which your signed code image will be distributed.
platform_display_name(Option<String>)
:A human-readable name for the signing platform associated with the signing job.
profile_name(Option<String>)
:The name of the profile that initiated the signing operation.
profile_version(Option<String>)
:The version of the signing profile used to initiate the signing job.
overrides(Option<SigningPlatformOverrides>)
:A list of any overrides that were applied to the signing operation.
signing_parameters(Option<HashMap::<String, String>>)
:Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.
created_at(Option<DateTime>)
:Date and time that the signing job was created.
completed_at(Option<DateTime>)
:Date and time that the signing job was completed.
signature_expires_at(Option<DateTime>)
:Thr expiration timestamp for the signature generated by the signing job.
requested_by(Option<String>)
:The IAM principal that requested the signing job.
status(Option<SigningStatus>)
:Status of the signing job.
status_reason(Option<String>)
:String value that contains the status reason.
revocation_record(Option<SigningJobRevocationRecord>)
:A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.
signed_object(Option<SignedObject>)
:Name of the S3 bucket where the signed code image is saved by AWS Signer.
job_owner(Option<String>)
:The AWS account ID of the job owner.
job_invoker(Option<String>)
:The IAM entity that initiated the signing job.
- On failure, responds with
SdkError<DescribeSigningJobError>
Source§impl Client
impl Client
Sourcepub fn get_revocation_status(&self) -> GetRevocationStatusFluentBuilder
pub fn get_revocation_status(&self) -> GetRevocationStatusFluentBuilder
Constructs a fluent builder for the GetRevocationStatus
operation.
- The fluent builder is configurable:
signature_timestamp(DateTime)
/set_signature_timestamp(Option<DateTime>)
:
required: trueThe timestamp of the signature that validates the profile or job.
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:
required: trueThe ID of a signing platform.
profile_version_arn(impl Into<String>)
/set_profile_version_arn(Option<String>)
:
required: trueThe version of a signing profile.
job_arn(impl Into<String>)
/set_job_arn(Option<String>)
:
required: trueThe ARN of a signing job.
certificate_hashes(impl Into<String>)
/set_certificate_hashes(Option<Vec::<String>>)
:
required: trueA list of composite signed hashes that identify certificates.
A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.
The following example shows how to calculate a hash for this parameter using OpenSSL commands:
openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs
openssl sha384 < childCert.tbs -binary > childCertTbsHash
openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs
openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p childCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >> certificateHash.hex
cat certificateHash.hex | tr -d ‘\n’
- On success, responds with
GetRevocationStatusOutput
with field(s):revoked_entities(Option<Vec::<String>>)
:A list of revoked entities (including zero or more of the signing profile ARN, signing job ARN, and certificate hashes) supplied as input to the API.
- On failure, responds with
SdkError<GetRevocationStatusError>
Source§impl Client
impl Client
Sourcepub fn get_signing_platform(&self) -> GetSigningPlatformFluentBuilder
pub fn get_signing_platform(&self) -> GetSigningPlatformFluentBuilder
Constructs a fluent builder for the GetSigningPlatform
operation.
- The fluent builder is configurable:
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:
required: trueThe ID of the target signing platform.
- On success, responds with
GetSigningPlatformOutput
with field(s):platform_id(Option<String>)
:The ID of the target signing platform.
display_name(Option<String>)
:The display name of the target signing platform.
partner(Option<String>)
:A list of partner entities that use the target signing platform.
target(Option<String>)
:The validation template that is used by the target signing platform.
category(Option<Category>)
:The category type of the target signing platform.
signing_configuration(Option<SigningConfiguration>)
:A list of configurations applied to the target platform at signing.
signing_image_format(Option<SigningImageFormat>)
:The format of the target platform’s signing image.
max_size_in_mb(i32)
:The maximum size (in MB) of the payload that can be signed by the target platform.
revocation_supported(bool)
:A flag indicating whether signatures generated for the signing platform can be revoked.
- On failure, responds with
SdkError<GetSigningPlatformError>
Source§impl Client
impl Client
Sourcepub fn get_signing_profile(&self) -> GetSigningProfileFluentBuilder
pub fn get_signing_profile(&self) -> GetSigningProfileFluentBuilder
Constructs a fluent builder for the GetSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the target signing profile.
profile_owner(impl Into<String>)
/set_profile_owner(Option<String>)
:
required: falseThe AWS account ID of the profile owner.
- On success, responds with
GetSigningProfileOutput
with field(s):profile_name(Option<String>)
:The name of the target signing profile.
profile_version(Option<String>)
:The current version of the signing profile.
profile_version_arn(Option<String>)
:The signing profile ARN, including the profile version.
revocation_record(Option<SigningProfileRevocationRecord>)
:Revocation information for a signing profile.
signing_material(Option<SigningMaterial>)
:The ARN of the certificate that the target profile uses for signing operations.
platform_id(Option<String>)
:The ID of the platform that is used by the target signing profile.
platform_display_name(Option<String>)
:A human-readable name for the signing platform associated with the signing profile.
signature_validity_period(Option<SignatureValidityPeriod>)
:The validity period for a signing job.
overrides(Option<SigningPlatformOverrides>)
:A list of overrides applied by the target signing profile for signing operations.
signing_parameters(Option<HashMap::<String, String>>)
:A map of key-value pairs for signing operations that is attached to the target signing profile.
status(Option<SigningProfileStatus>)
:The status of the target signing profile.
status_reason(Option<String>)
:Reason for the status of the target signing profile.
arn(Option<String>)
:The Amazon Resource Name (ARN) for the signing profile.
tags(Option<HashMap::<String, String>>)
:A list of tags associated with the signing profile.
- On failure, responds with
SdkError<GetSigningProfileError>
Source§impl Client
impl Client
Sourcepub fn list_profile_permissions(&self) -> ListProfilePermissionsFluentBuilder
pub fn list_profile_permissions(&self) -> ListProfilePermissionsFluentBuilder
Constructs a fluent builder for the ListProfilePermissions
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueName of the signing profile containing the cross-account permissions.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseString for specifying the next set of paginated results.
- On success, responds with
ListProfilePermissionsOutput
with field(s):revision_id(Option<String>)
:The identifier for the current revision of profile permissions.
policy_size_bytes(i32)
:Total size of the policy associated with the Signing Profile in bytes.
permissions(Option<Vec::<Permission>>)
:List of permissions associated with the Signing Profile.
next_token(Option<String>)
:String for specifying the next set of paginated results.
- On failure, responds with
SdkError<ListProfilePermissionsError>
Source§impl Client
impl Client
Sourcepub fn list_signing_jobs(&self) -> ListSigningJobsFluentBuilder
pub fn list_signing_jobs(&self) -> ListSigningJobsFluentBuilder
Constructs a fluent builder for the ListSigningJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
status(SigningStatus)
/set_status(Option<SigningStatus>)
:
required: falseA status value with which to filter your results.
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:
required: falseThe ID of microcontroller platform that you specified for the distribution of your code image.
requested_by(impl Into<String>)
/set_requested_by(Option<String>)
:
required: falseThe IAM principal that requested the signing job.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the
nextToken
element is set in the response. Use thenextToken
value in a subsequent request to retrieve additional items.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseString for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of
nextToken
from the response that you just received.is_revoked(bool)
/set_is_revoked(Option<bool>)
:
required: falseFilters results to return only signing jobs with revoked signatures.
signature_expires_before(DateTime)
/set_signature_expires_before(Option<DateTime>)
:
required: falseFilters results to return only signing jobs with signatures expiring before a specified timestamp.
signature_expires_after(DateTime)
/set_signature_expires_after(Option<DateTime>)
:
required: falseFilters results to return only signing jobs with signatures expiring after a specified timestamp.
job_invoker(impl Into<String>)
/set_job_invoker(Option<String>)
:
required: falseFilters results to return only signing jobs initiated by a specified IAM entity.
- On success, responds with
ListSigningJobsOutput
with field(s):jobs(Option<Vec::<SigningJob>>)
:A list of your signing jobs.
next_token(Option<String>)
:String for specifying the next set of paginated results.
- On failure, responds with
SdkError<ListSigningJobsError>
Source§impl Client
impl Client
Sourcepub fn list_signing_platforms(&self) -> ListSigningPlatformsFluentBuilder
pub fn list_signing_platforms(&self) -> ListSigningPlatformsFluentBuilder
Constructs a fluent builder for the ListSigningPlatforms
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
category(impl Into<String>)
/set_category(Option<String>)
:
required: falseThe category type of a signing platform.
partner(impl Into<String>)
/set_partner(Option<String>)
:
required: falseAny partner entities connected to a signing platform.
target(impl Into<String>)
/set_target(Option<String>)
:
required: falseThe validation template that is used by the target signing platform.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned by this operation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseValue for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of
nextToken
from the response that you just received.
- On success, responds with
ListSigningPlatformsOutput
with field(s):platforms(Option<Vec::<SigningPlatform>>)
:A list of all platforms that match the request parameters.
next_token(Option<String>)
:Value for specifying the next set of paginated results to return.
- On failure, responds with
SdkError<ListSigningPlatformsError>
Source§impl Client
impl Client
Sourcepub fn list_signing_profiles(&self) -> ListSigningProfilesFluentBuilder
pub fn list_signing_profiles(&self) -> ListSigningProfilesFluentBuilder
Constructs a fluent builder for the ListSigningProfiles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
include_canceled(bool)
/set_include_canceled(Option<bool>)
:
required: falseDesignates whether to include profiles with the status of
CANCELED
.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of profiles to be returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseValue for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of
nextToken
from the response that you just received.platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:
required: falseFilters results to return only signing jobs initiated for a specified signing platform.
statuses(SigningProfileStatus)
/set_statuses(Option<Vec::<SigningProfileStatus>>)
:
required: falseFilters results to return only signing jobs with statuses in the specified list.
- On success, responds with
ListSigningProfilesOutput
with field(s):profiles(Option<Vec::<SigningProfile>>)
:A list of profiles that are available in the AWS account. This includes profiles with the status of
CANCELED
if theincludeCanceled
parameter is set totrue
.next_token(Option<String>)
:Value for specifying the next set of paginated results to return.
- On failure, responds with
SdkError<ListSigningProfilesError>
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) for the signing profile.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:A list of tags associated with the signing profile.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn put_signing_profile(&self) -> PutSigningProfileFluentBuilder
pub fn put_signing_profile(&self) -> PutSigningProfileFluentBuilder
Constructs a fluent builder for the PutSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the signing profile to be created.
signing_material(SigningMaterial)
/set_signing_material(Option<SigningMaterial>)
:
required: falseThe AWS Certificate Manager certificate that will be used to sign code with the new signing profile.
signature_validity_period(SignatureValidityPeriod)
/set_signature_validity_period(Option<SignatureValidityPeriod>)
:
required: falseThe default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:
required: trueThe ID of the signing platform to be created.
overrides(SigningPlatformOverrides)
/set_overrides(Option<SigningPlatformOverrides>)
:
required: falseA subfield of
platform
. This specifies any different configuration options that you want to apply to the chosen platform (such as a differenthash-algorithm
orsigning-algorithm
).signing_parameters(impl Into<String>, impl Into<String>)
/set_signing_parameters(Option<HashMap::<String, String>>)
:
required: falseMap of key-value pairs for signing. These can include any information that you want to use during signing.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags to be associated with the signing profile that is being created.
- On success, responds with
PutSigningProfileOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the signing profile created.
profile_version(Option<String>)
:The version of the signing profile being created.
profile_version_arn(Option<String>)
:The signing profile ARN, including the profile version.
- On failure, responds with
SdkError<PutSigningProfileError>
Source§impl Client
impl Client
Sourcepub fn remove_profile_permission(&self) -> RemoveProfilePermissionFluentBuilder
pub fn remove_profile_permission(&self) -> RemoveProfilePermissionFluentBuilder
Constructs a fluent builder for the RemoveProfilePermission
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueA human-readable name for the signing profile with permissions to be removed.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:
required: trueAn identifier for the current revision of the signing profile permissions.
statement_id(impl Into<String>)
/set_statement_id(Option<String>)
:
required: trueA unique identifier for the cross-account permissions statement.
- On success, responds with
RemoveProfilePermissionOutput
with field(s):revision_id(Option<String>)
:An identifier for the current revision of the profile permissions.
- On failure, responds with
SdkError<RemoveProfilePermissionError>
Source§impl Client
impl Client
Sourcepub fn revoke_signature(&self) -> RevokeSignatureFluentBuilder
pub fn revoke_signature(&self) -> RevokeSignatureFluentBuilder
Constructs a fluent builder for the RevokeSignature
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueID of the signing job to be revoked.
job_owner(impl Into<String>)
/set_job_owner(Option<String>)
:
required: falseAWS account ID of the job owner.
reason(impl Into<String>)
/set_reason(Option<String>)
:
required: trueThe reason for revoking the signing job.
- On success, responds with
RevokeSignatureOutput
- On failure, responds with
SdkError<RevokeSignatureError>
Source§impl Client
impl Client
Sourcepub fn revoke_signing_profile(&self) -> RevokeSigningProfileFluentBuilder
pub fn revoke_signing_profile(&self) -> RevokeSigningProfileFluentBuilder
Constructs a fluent builder for the RevokeSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the signing profile to be revoked.
profile_version(impl Into<String>)
/set_profile_version(Option<String>)
:
required: trueThe version of the signing profile to be revoked.
reason(impl Into<String>)
/set_reason(Option<String>)
:
required: trueThe reason for revoking a signing profile.
effective_time(DateTime)
/set_effective_time(Option<DateTime>)
:
required: trueA timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.
- On success, responds with
RevokeSigningProfileOutput
- On failure, responds with
SdkError<RevokeSigningProfileError>
Source§impl Client
impl Client
Sourcepub fn sign_payload(&self) -> SignPayloadFluentBuilder
pub fn sign_payload(&self) -> SignPayloadFluentBuilder
Constructs a fluent builder for the SignPayload
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the signing profile.
profile_owner(impl Into<String>)
/set_profile_owner(Option<String>)
:
required: falseThe AWS account ID of the profile owner.
payload(Blob)
/set_payload(Option<Blob>)
:
required: trueSpecifies the object digest (hash) to sign.
payload_format(impl Into<String>)
/set_payload_format(Option<String>)
:
required: truePayload content type. The single valid type is
application/vnd.cncf.notary.payload.v1+json
.
- On success, responds with
SignPayloadOutput
with field(s):job_id(Option<String>)
:Unique identifier of the signing job.
job_owner(Option<String>)
:The AWS account ID of the job owner.
metadata(Option<HashMap::<String, String>>)
:Information including the signing profile ARN and the signing job ID.
signature(Option<Blob>)
:A cryptographic signature.
- On failure, responds with
SdkError<SignPayloadError>
Source§impl Client
impl Client
Sourcepub fn start_signing_job(&self) -> StartSigningJobFluentBuilder
pub fn start_signing_job(&self) -> StartSigningJobFluentBuilder
Constructs a fluent builder for the StartSigningJob
operation.
- The fluent builder is configurable:
source(Source)
/set_source(Option<Source>)
:
required: trueThe S3 bucket that contains the object to sign or a BLOB that contains your raw code.
destination(Destination)
/set_destination(Option<Destination>)
:
required: trueThe S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:
required: trueThe name of the signing profile.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:
required: trueString that identifies the signing request. All calls after the first that use this token return the same response as the first call.
profile_owner(impl Into<String>)
/set_profile_owner(Option<String>)
:
required: falseThe AWS account ID of the signing profile owner.
- On success, responds with
StartSigningJobOutput
with field(s):job_id(Option<String>)
:The ID of your signing job.
job_owner(Option<String>)
:The AWS account ID of the signing job owner.
- On failure, responds with
SdkError<StartSigningJobError>
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) for the signing profile.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueOne or more tags to be associated with the signing profile.
- 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) for the signing profile.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of tag keys to be removed from the signing profile.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
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§
Source§impl Waiters for Client
impl Waiters for Client
Source§fn wait_until_successful_signing_job(&self) -> SuccessfulSigningJobFluentBuilder
fn wait_until_successful_signing_job(&self) -> SuccessfulSigningJobFluentBuilder
successful_signing_job
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);