Struct aws_sdk_signer::Client
source · [−]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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_signer::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_signer::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_signer::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn add_profile_permission(&self) -> AddProfilePermission
pub fn add_profile_permission(&self) -> AddProfilePermission
Constructs a fluent builder for the AddProfilePermission
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:The human-readable name of the signing profile.
profile_version(impl Into<String>)
/set_profile_version(Option<String>)
:The version of the signing profile.
action(impl Into<String>)
/set_action(Option<String>)
:The AWS Signer action permitted as part of cross-account permissions.
principal(impl Into<String>)
/set_principal(Option<String>)
:The 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>)
:A unique identifier for the current profile revision.
statement_id(impl Into<String>)
/set_statement_id(Option<String>)
:A 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>
sourcepub fn cancel_signing_profile(&self) -> CancelSigningProfile
pub fn cancel_signing_profile(&self) -> CancelSigningProfile
Constructs a fluent builder for the CancelSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:The name of the signing profile to be canceled.
- On success, responds with
CancelSigningProfileOutput
- On failure, responds with
SdkError<CancelSigningProfileError>
sourcepub fn describe_signing_job(&self) -> DescribeSigningJob
pub fn describe_signing_job(&self) -> DescribeSigningJob
Constructs a fluent builder for the DescribeSigningJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The 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 code signing.
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>
sourcepub fn get_signing_platform(&self) -> GetSigningPlatform
pub fn get_signing_platform(&self) -> GetSigningPlatform
Constructs a fluent builder for the GetSigningPlatform
operation.
- The fluent builder is configurable:
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:The 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>
sourcepub fn get_signing_profile(&self) -> GetSigningProfile
pub fn get_signing_profile(&self) -> GetSigningProfile
Constructs a fluent builder for the GetSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:The name of the target signing profile.
profile_owner(impl Into<String>)
/set_profile_owner(Option<String>)
:The 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>
sourcepub fn list_profile_permissions(&self) -> ListProfilePermissions
pub fn list_profile_permissions(&self) -> ListProfilePermissions
Constructs a fluent builder for the ListProfilePermissions
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:Name of the signing profile containing the cross-account permissions.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:String 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>
sourcepub fn list_signing_jobs(&self) -> ListSigningJobs
pub fn list_signing_jobs(&self) -> ListSigningJobs
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>)
:A status value with which to filter your results.
platform_id(impl Into<String>)
/set_platform_id(Option<String>)
:The ID of microcontroller platform that you specified for the distribution of your code image.
requested_by(impl Into<String>)
/set_requested_by(Option<String>)
:The IAM principal that requested the signing job.
max_results(i32)
/set_max_results(Option<i32>)
:Specifies 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>)
:String 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(bool)
:Filters results to return only signing jobs with revoked signatures.
signature_expires_before(DateTime)
/set_signature_expires_before(Option<DateTime>)
:Filters results to return only signing jobs with signatures expiring before a specified timestamp.
signature_expires_after(DateTime)
/set_signature_expires_after(Option<DateTime>)
:Filters results to return only signing jobs with signatures expiring after a specified timestamp.
job_invoker(impl Into<String>)
/set_job_invoker(Option<String>)
:Filters 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>
sourcepub fn list_signing_platforms(&self) -> ListSigningPlatforms
pub fn list_signing_platforms(&self) -> ListSigningPlatforms
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>)
:The category type of a signing platform.
partner(impl Into<String>)
/set_partner(Option<String>)
:Any partner entities connected to a signing platform.
target(impl Into<String>)
/set_target(Option<String>)
:The validation template that is used by the target signing platform.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned by this operation.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Value 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>
sourcepub fn list_signing_profiles(&self) -> ListSigningProfiles
pub fn list_signing_profiles(&self) -> ListSigningProfiles
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(bool)
:Designates whether to include profiles with the status of
CANCELED
.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of profiles to be returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Value 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>)
:Filters results to return only signing jobs initiated for a specified signing platform.
statuses(Vec<SigningProfileStatus>)
/set_statuses(Option<Vec<SigningProfileStatus>>)
:Filters 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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The 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>
sourcepub fn put_signing_profile(&self) -> PutSigningProfile
pub fn put_signing_profile(&self) -> PutSigningProfile
Constructs a fluent builder for the PutSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:The name of the signing profile to be created.
signing_material(SigningMaterial)
/set_signing_material(Option<SigningMaterial>)
:The 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>)
:The 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>)
:The ID of the signing platform to be created.
overrides(SigningPlatformOverrides)
/set_overrides(Option<SigningPlatformOverrides>)
:A 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(HashMap<String, String>)
/set_signing_parameters(Option<HashMap<String, String>>)
:Map of key-value pairs for signing. These can include any information that you want to use during signing.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Tags 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>
sourcepub fn remove_profile_permission(&self) -> RemoveProfilePermission
pub fn remove_profile_permission(&self) -> RemoveProfilePermission
Constructs a fluent builder for the RemoveProfilePermission
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:A human-readable name for the signing profile with permissions to be removed.
revision_id(impl Into<String>)
/set_revision_id(Option<String>)
:An identifier for the current revision of the signing profile permissions.
statement_id(impl Into<String>)
/set_statement_id(Option<String>)
:A 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>
sourcepub fn revoke_signature(&self) -> RevokeSignature
pub fn revoke_signature(&self) -> RevokeSignature
Constructs a fluent builder for the RevokeSignature
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:ID of the signing job to be revoked.
job_owner(impl Into<String>)
/set_job_owner(Option<String>)
:AWS account ID of the job owner.
reason(impl Into<String>)
/set_reason(Option<String>)
:The reason for revoking the signing job.
- On success, responds with
RevokeSignatureOutput
- On failure, responds with
SdkError<RevokeSignatureError>
sourcepub fn revoke_signing_profile(&self) -> RevokeSigningProfile
pub fn revoke_signing_profile(&self) -> RevokeSigningProfile
Constructs a fluent builder for the RevokeSigningProfile
operation.
- The fluent builder is configurable:
profile_name(impl Into<String>)
/set_profile_name(Option<String>)
:The name of the signing profile to be revoked.
profile_version(impl Into<String>)
/set_profile_version(Option<String>)
:The version of the signing profile to be revoked.
reason(impl Into<String>)
/set_reason(Option<String>)
:The reason for revoking a signing profile.
effective_time(DateTime)
/set_effective_time(Option<DateTime>)
:A 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>
sourcepub fn start_signing_job(&self) -> StartSigningJob
pub fn start_signing_job(&self) -> StartSigningJob
Constructs a fluent builder for the StartSigningJob
operation.
- The fluent builder is configurable:
source(Source)
/set_source(Option<Source>)
:The S3 bucket that contains the object to sign or a BLOB that contains your raw code.
destination(Destination)
/set_destination(Option<Destination>)
:The 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>)
:The name of the signing profile.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
:String 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>)
:The 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>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the signing profile.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:One or more tags to be associated with the signing profile.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) for the signing profile.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of tag keys to be removed from the signing profile.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more