Struct Client 

pub struct Client { /* private fields */ }

Client for Private CA Connector for SCEP

Client for invoking operations on Private CA Connector for SCEP. Each operation on Private CA Connector for SCEP 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_pcaconnectorscep::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_pcaconnectorscep::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 CreateChallenge operation has a Client::create_challenge, 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.create_challenge()
    .connector_arn("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

impl Client

pub fn create_challenge(&self) -> CreateChallengeFluentBuilder

Constructs a fluent builder for the CreateChallenge operation.

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector that you want to create a challenge for.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Custom string that can be used to distinguish between calls to the CreateChallenge action. Client tokens for CreateChallenge time out after five minutes. Therefore, if you call CreateChallenge multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The key-value pairs to associate with the resource.

    
    
• On success, responds with CreateChallengeOutput with field(s):
  • challenge(Option<Challenge>):

    Returns the challenge details for the specified connector.

• On failure, responds with SdkError<CreateChallengeError>

impl Client

pub fn create_connector(&self) -> CreateConnectorFluentBuilder

Constructs a fluent builder for the CreateConnector operation.

• The fluent builder is configurable:
  • certificate_authority_arn(impl Into<String>) / set_certificate_authority_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority certificate authority to use with this connector. Due to security vulnerabilities present in the SCEP protocol, we recommend using a private CA that’s dedicated for use with the connector.

    To retrieve the private CAs associated with your account, you can call ListCertificateAuthorities using the Amazon Web Services Private CA API.

    
    
  • mobile_device_management(MobileDeviceManagement) / set_mobile_device_management(Option<MobileDeviceManagement>):
    required: false
    

    If you don’t supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. With connectors for general-purpose use, you manage SCEP challenge passwords using Connector for SCEP. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations.

    If you provide an IntuneConfiguration, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Custom string that can be used to distinguish between calls to the CreateChallenge action. Client tokens for CreateChallenge time out after five minutes. Therefore, if you call CreateChallenge multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The key-value pairs to associate with the resource.

    
    
• On success, responds with CreateConnectorOutput with field(s):
  • connector_arn(Option<String>):

    Returns the Amazon Resource Name (ARN) of the connector.

• On failure, responds with SdkError<CreateConnectorError>

impl Client

pub fn delete_challenge(&self) -> DeleteChallengeFluentBuilder

Constructs a fluent builder for the DeleteChallenge operation.

• The fluent builder is configurable:
  • challenge_arn(impl Into<String>) / set_challenge_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the challenge password to delete.

    
    
• On success, responds with DeleteChallengeOutput
• On failure, responds with SdkError<DeleteChallengeError>

impl Client

pub fn delete_connector(&self) -> DeleteConnectorFluentBuilder

Constructs a fluent builder for the DeleteConnector operation.

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector to delete.

    
    
• On success, responds with DeleteConnectorOutput
• On failure, responds with SdkError<DeleteConnectorError>

impl Client

pub fn get_challenge_metadata(&self) -> GetChallengeMetadataFluentBuilder

Constructs a fluent builder for the GetChallengeMetadata operation.

• The fluent builder is configurable:
  • challenge_arn(impl Into<String>) / set_challenge_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the challenge.

    
    
• On success, responds with GetChallengeMetadataOutput with field(s):
  • challenge_metadata(Option<ChallengeMetadata>):

    The metadata for the challenge.

• On failure, responds with SdkError<GetChallengeMetadataError>

impl Client

pub fn get_challenge_password(&self) -> GetChallengePasswordFluentBuilder

Constructs a fluent builder for the GetChallengePassword operation.

• The fluent builder is configurable:
  • challenge_arn(impl Into<String>) / set_challenge_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the challenge.

    
    
• On success, responds with GetChallengePasswordOutput with field(s):
  • password(Option<String>):

    The SCEP challenge password.

• On failure, responds with SdkError<GetChallengePasswordError>

impl Client

pub fn get_connector(&self) -> GetConnectorFluentBuilder

Constructs a fluent builder for the GetConnector operation.

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector.

    
    
• On success, responds with GetConnectorOutput with field(s):
  • connector(Option<Connector>):

    The properties of the connector.

• On failure, responds with SdkError<GetConnectorError>

impl Client

pub fn list_challenge_metadata(&self) -> ListChallengeMetadataFluentBuilder

Constructs a fluent builder for the ListChallengeMetadata operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    
    
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector.

    
    
• On success, responds with ListChallengeMetadataOutput with field(s):
  • challenges(Option<Vec::<ChallengeMetadataSummary>>):

    The challenge metadata for the challenges belonging to your Amazon Web Services account.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListChallengeMetadataError>

impl Client

pub fn list_connectors(&self) -> ListConnectorsFluentBuilder

Constructs a fluent builder for the ListConnectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

    
    
• On success, responds with ListConnectorsOutput with field(s):
  • connectors(Option<Vec::<ConnectorSummary>>):

    The connectors belonging to your Amazon Web Services account.

  • next_token(Option<String>):

    When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

• On failure, responds with SdkError<ListConnectorsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The key-value pairs to associate with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The key-value pairs to associate with the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Specifies a list of tag keys that you want to remove from the specified resources.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.