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::retry::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

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

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>

source

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>

source

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>

source

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>

source

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>

source

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>

source

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 the nextToken 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>

source

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>

source

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 the includeCanceled parameter is set to true.
- next_token(Option<String>):
 Value for specifying the next set of paginated results to return.
On failure, responds with SdkError<ListSigningProfilesError>