Struct aws_sdk_artifact::Client

pub struct Client { /* private fields */ }

Client for AWS Artifact

Client for invoking operations on AWS Artifact. Each operation on AWS Artifact 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_artifact::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 Config 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_artifact::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.

Implementations

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    Account settings for the customer.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_report(&self) -> GetReportFluentBuilder

Constructs a fluent builder for the GetReport operation.

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

    Unique resource ID for the report resource.

    
    
  • report_version(i64) / set_report_version(Option<i64>):
    required: false
    

    Version for the report resource.

    
    
  • term_token(impl Into<String>) / set_term_token(Option<String>):
    required: true
    

    Unique download token provided by GetTermForReport API.

    
    
• On success, responds with GetReportOutput with field(s):
  • document_presigned_url(Option<String>):

    Presigned S3 url to access the report content.

• On failure, responds with SdkError<GetReportError>

impl Client

pub fn get_report_metadata(&self) -> GetReportMetadataFluentBuilder

Constructs a fluent builder for the GetReportMetadata operation.

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

    Unique resource ID for the report resource.

    
    
  • report_version(i64) / set_report_version(Option<i64>):
    required: false
    

    Version for the report resource.

    
    
• On success, responds with GetReportMetadataOutput with field(s):
  • report_details(Option<ReportDetail>):

    Report resource detail.

• On failure, responds with SdkError<GetReportMetadataError>

impl Client

pub fn get_term_for_report(&self) -> GetTermForReportFluentBuilder

Constructs a fluent builder for the GetTermForReport operation.

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

    Unique resource ID for the report resource.

    
    
  • report_version(i64) / set_report_version(Option<i64>):
    required: false
    

    Version for the report resource.

    
    
• On success, responds with GetTermForReportOutput with field(s):
  • document_presigned_url(Option<String>):

    Presigned S3 url to access the term content.

  • term_token(Option<String>):

    Unique token representing this request event.

• On failure, responds with SdkError<GetTermForReportError>

impl Client

pub fn list_reports(&self) -> ListReportsFluentBuilder

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

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

    Maximum number of resources to return in the paginated response.

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

    Pagination token to request the next page of resources.

    
    
• On success, responds with ListReportsOutput with field(s):
  • reports(Option<Vec::<ReportSummary>>):

    List of report resources.

  • next_token(Option<String>):

    Pagination token to request the next page of resources.

• On failure, responds with SdkError<ListReportsError>

impl Client

pub fn put_account_settings(&self) -> PutAccountSettingsFluentBuilder

Constructs a fluent builder for the PutAccountSettings operation.

• The fluent builder is configurable:
  • notification_subscription_status(NotificationSubscriptionStatus) / set_notification_subscription_status(Option<NotificationSubscriptionStatus>):
    required: false
    

    Desired notification subscription status.

    
    
• On success, responds with PutAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    Account settings for the customer.

• On failure, responds with SdkError<PutAccountSettingsError>

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 copy 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.