Struct aws_sdk_rum::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Client for CloudWatch RUM

Client for invoking operations on CloudWatch RUM. Each operation on CloudWatch RUM 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_rum::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_rum::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_rum::Client::from_conf(config);

Implementations

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn create_app_monitor(&self) -> CreateAppMonitor<C, M, R>

Constructs a fluent builder for the CreateAppMonitor operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    A name for the app monitor.

  • domain(impl Into<String>) / set_domain(Option<String>):

    The top-level internet domain name for which your application has administrative authority.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Assigns one or more tags (key-value pairs) to the app monitor.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    Tags don’t have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

    You can associate as many as 50 tags with an app monitor.

    For more information, see Tagging Amazon Web Services resources.

  • app_monitor_configuration(AppMonitorConfiguration) / set_app_monitor_configuration(Option<AppMonitorConfiguration>):

    A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don’t include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

    If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

  • cw_log_enabled(bool) / set_cw_log_enabled(Option<bool>):

    Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

    If you omit this parameter, the default is false.

• On success, responds with CreateAppMonitorOutput with field(s):
  • id(Option<String>):

    The unique ID of the new app monitor.

• On failure, responds with SdkError<CreateAppMonitorError>

pub fn delete_app_monitor(&self) -> DeleteAppMonitor<C, M, R>

Constructs a fluent builder for the DeleteAppMonitor operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the app monitor to delete.

• On success, responds with DeleteAppMonitorOutput
• On failure, responds with SdkError<DeleteAppMonitorError>

pub fn get_app_monitor(&self) -> GetAppMonitor<C, M, R>

Constructs a fluent builder for the GetAppMonitor operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The app monitor to retrieve information for.

• On success, responds with GetAppMonitorOutput with field(s):
  • app_monitor(Option<AppMonitor>):

    A structure containing all the configuration information for the app monitor.

• On failure, responds with SdkError<GetAppMonitorError>

pub fn get_app_monitor_data(&self) -> GetAppMonitorData<C, M, R>

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

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the app monitor that collected the data that you want to retrieve.

  • time_range(TimeRange) / set_time_range(Option<TimeRange>):

    A structure that defines the time range that you want to retrieve results from.

  • filters(Vec<QueryFilter>) / set_filters(Option<Vec<QueryFilter>>):

    An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify.

  • max_results(i32) / set_max_results(i32):

    The maximum number of results to return in one operation.

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

    Use the token returned by the previous operation to request the next page of results.

• On success, responds with GetAppMonitorDataOutput with field(s):
  • events(Option<Vec<String>>):

    The events that RUM collected that match your request.

  • next_token(Option<String>):

    A token that you can use in a subsequent operation to retrieve the next set of results.

• On failure, responds with SdkError<GetAppMonitorDataError>

pub fn list_app_monitors(&self) -> ListAppMonitors<C, M, R>

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

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

    The maximum number of results to return in one operation.

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

    Use the token returned by the previous operation to request the next page of results.

• On success, responds with ListAppMonitorsOutput with field(s):
  • next_token(Option<String>):

    A token that you can use in a subsequent operation to retrieve the next set of results.

  • app_monitor_summaries(Option<Vec<AppMonitorSummary>>):

    An array of structures that contain information about the returned app monitors.

• On failure, responds with SdkError<ListAppMonitorsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource<C, M, R>

Constructs a fluent builder for the ListTagsForResource operation.

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

    The ARN of the resource that you want to see the tags of.

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

    The ARN of the resource that you are viewing.

  • tags(Option<HashMap<String, String>>):

    The list of tag keys and values associated with the resource you specified.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn put_rum_events(&self) -> PutRumEvents<C, M, R>

Constructs a fluent builder for the PutRumEvents operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The ID of the app monitor that is sending this data.

  • batch_id(impl Into<String>) / set_batch_id(Option<String>):

    A unique identifier for this batch of RUM event data.

  • app_monitor_details(AppMonitorDetails) / set_app_monitor_details(Option<AppMonitorDetails>):

    A structure that contains information about the app monitor that collected this telemetry information.

  • user_details(UserDetails) / set_user_details(Option<UserDetails>):

    A structure that contains information about the user session that this batch of events was collected from.

  • rum_events(Vec<RumEvent>) / set_rum_events(Option<Vec<RumEvent>>):

    An array of structures that contain the telemetry event data.

• On success, responds with PutRumEventsOutput
• On failure, responds with SdkError<PutRumEventsError>

pub fn tag_resource(&self) -> TagResource<C, M, R>

Constructs a fluent builder for the TagResource operation.

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

    The ARN of the CloudWatch RUM resource that you’re adding tags to.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The list of key-value pairs to associate with the resource.

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

pub fn untag_resource(&self) -> UntagResource<C, M, R>

Constructs a fluent builder for the UntagResource operation.

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

    The ARN of the CloudWatch RUM resource that you’re removing tags from.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The list of tag keys to remove from the resource.

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

pub fn update_app_monitor(&self) -> UpdateAppMonitor<C, M, R>

Constructs a fluent builder for the UpdateAppMonitor operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the app monitor to update.

  • domain(impl Into<String>) / set_domain(Option<String>):

    The top-level internet domain name for which your application has administrative authority.

  • app_monitor_configuration(AppMonitorConfiguration) / set_app_monitor_configuration(Option<AppMonitorConfiguration>):

    A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don’t include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

  • cw_log_enabled(bool) / set_cw_log_enabled(Option<bool>):

    Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

• On success, responds with UpdateAppMonitorOutput
• On failure, responds with SdkError<UpdateAppMonitorError>

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.