Struct Client

pub struct Client { /* private fields */ }

Client for Network Flow Monitor

Client for invoking operations on Network Flow Monitor. Each operation on Network Flow Monitor 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_networkflowmonitor::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_networkflowmonitor::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 CreateMonitor operation has a Client::create_monitor, 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_monitor()
    .monitor_name("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_monitor(&self) -> CreateMonitorFluentBuilder

Constructs a fluent builder for the CreateMonitor operation.

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

    The name of the monitor.

    
    
  • local_resources(MonitorLocalResource) / set_local_resources(Option<Vec::<MonitorLocalResource>>):
    required: true
    

    The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Relational Database Service (RDS)), the EC2 instance hosting the web service, which also runs the agent, is the local resource.

    
    
  • remote_resources(MonitorRemoteResource) / set_remote_resources(Option<Vec::<MonitorRemoteResource>>):
    required: false
    

    The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource.

    
    
  • scope_arn(impl Into<String>) / set_scope_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the scope for the monitor.

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

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

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

    The tags for a monitor. You can add a maximum of 200 tags.

    
    
• On success, responds with CreateMonitorOutput with field(s):
  • monitor_arn(String):

    The Amazon Resource Name (ARN) of the monitor.

  • monitor_name(String):

    The name of the monitor.

  • monitor_status(MonitorStatus):

    The status of a monitor. The status can be one of the following

    • PENDING: The monitor is in the process of being created.

    • ACTIVE: The monitor is active.

    • INACTIVE: The monitor is inactive.

    • ERROR: Monitor creation failed due to an error.

    • DELETING: The monitor is in the process of being deleted.

  • local_resources(Vec::<MonitorLocalResource>):

    The local resources to monitor. A local resource, in a bi-directional flow of a workload, is the host where the agent is installed.

  • remote_resources(Vec::<MonitorRemoteResource>):

    The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Relational Database Service (RDS) can be a remote resource. The remote resource is identified by its ARN or an identifier.

  • created_at(DateTime):

    The date and time when the monitor was created.

  • modified_at(DateTime):

    The last date and time that the monitor was modified.

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

    The tags for a monitor.

• On failure, responds with SdkError<CreateMonitorError>

impl Client

pub fn create_scope(&self) -> CreateScopeFluentBuilder

Constructs a fluent builder for the CreateScope operation.

• The fluent builder is configurable:
  • targets(TargetResource) / set_targets(Option<Vec::<TargetResource>>):
    required: true
    

    The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.

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

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

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

    The tags for a scope. You can add a maximum of 200 tags.

    
    
• On success, responds with CreateScopeOutput with field(s):
  • scope_id(String):

    The identifier for the scope that includes the resources you want to get metrics for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • status(ScopeStatus):

    The status for a call to create a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.

  • scope_arn(String):

    The Amazon Resource Name (ARN) of the scope.

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

    The tags for a scope.

• On failure, responds with SdkError<CreateScopeError>

impl Client

pub fn delete_monitor(&self) -> DeleteMonitorFluentBuilder

Constructs a fluent builder for the DeleteMonitor operation.

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

    The name of the monitor to delete.

    
    
• On success, responds with DeleteMonitorOutput
• On failure, responds with SdkError<DeleteMonitorError>

impl Client

pub fn delete_scope(&self) -> DeleteScopeFluentBuilder

Constructs a fluent builder for the DeleteScope operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
• On success, responds with DeleteScopeOutput
• On failure, responds with SdkError<DeleteScopeError>

impl Client

pub fn get_monitor(&self) -> GetMonitorFluentBuilder

Constructs a fluent builder for the GetMonitor operation.

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

    The name of the monitor.

    
    
• On success, responds with GetMonitorOutput with field(s):
  • monitor_arn(String):

    The Amazon Resource Name (ARN) of the monitor.

  • monitor_name(String):

    The name of the monitor.

  • monitor_status(MonitorStatus):

    The status of a monitor. The status can be one of the following

    • PENDING: The monitor is in the process of being created.

    • ACTIVE: The monitor is active.

    • INACTIVE: The monitor is inactive.

    • ERROR: Monitor creation failed due to an error.

    • DELETING: The monitor is in the process of being deleted.

  • local_resources(Vec::<MonitorLocalResource>):

    The local resources for this monitor.

  • remote_resources(Vec::<MonitorRemoteResource>):

    The remote resources for this monitor.

  • created_at(DateTime):

    The date and time when the monitor was created.

  • modified_at(DateTime):

    The date and time when the monitor was last modified.

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

    The tags for a monitor.

• On failure, responds with SdkError<GetMonitorError>

impl Client

pub fn get_query_results_monitor_top_contributors( &self, ) -> GetQueryResultsMonitorTopContributorsFluentBuilder

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

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

    The name of the monitor.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

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

    The token for the next set of results. You receive this token from a previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of query results that you want to return with this call.

    
    
• On success, responds with GetQueryResultsMonitorTopContributorsOutput with field(s):
  • unit(Option<MetricUnit>):

    The units for a metric returned by the query.

  • top_contributors(Option<Vec::<MonitorTopContributorsRow>>):

    The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.

  • next_token(Option<String>):

    The token for the next set of results. You receive this token from a previous call.

• On failure, responds with SdkError<GetQueryResultsMonitorTopContributorsError>

impl Client

pub fn get_query_results_workload_insights_top_contributors( &self, ) -> GetQueryResultsWorkloadInsightsTopContributorsFluentBuilder

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

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

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

    The token for the next set of results. You receive this token from a previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of query results that you want to return with this call.

    
    
• On success, responds with GetQueryResultsWorkloadInsightsTopContributorsOutput with field(s):
  • top_contributors(Option<Vec::<WorkloadInsightsTopContributorsRow>>):

    The top contributor network flows overall for a specific metric type, for example, the number of retransmissions.

  • next_token(Option<String>):

    The token for the next set of results. You receive this token from a previous call.

• On failure, responds with SdkError<GetQueryResultsWorkloadInsightsTopContributorsError>

impl Client

pub fn get_query_results_workload_insights_top_contributors_data( &self, ) -> GetQueryResultsWorkloadInsightsTopContributorsDataFluentBuilder

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

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

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

    The token for the next set of results. You receive this token from a previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of query results that you want to return with this call.

    
    
• On success, responds with GetQueryResultsWorkloadInsightsTopContributorsDataOutput with field(s):
  • unit(MetricUnit):

    The units for a metric returned by the query.

  • datapoints(Vec::<WorkloadInsightsTopContributorsDataPoint>):

    The datapoints returned by the query.

  • next_token(Option<String>):

    The token for the next set of results. You receive this token from a previous call.

• On failure, responds with SdkError<GetQueryResultsWorkloadInsightsTopContributorsDataError>

impl Client

pub fn get_query_status_monitor_top_contributors( &self, ) -> GetQueryStatusMonitorTopContributorsFluentBuilder

Constructs a fluent builder for the GetQueryStatusMonitorTopContributors operation.

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

    The name of the monitor.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with GetQueryStatusMonitorTopContributorsOutput with field(s):
  • status(QueryStatus):

    When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.

    • QUEUED: The query is scheduled to run.

    • RUNNING: The query is in progress but not complete.

    • SUCCEEDED: The query completed sucessfully.

    • FAILED: The query failed due to an error.

    • CANCELED: The query was canceled.

• On failure, responds with SdkError<GetQueryStatusMonitorTopContributorsError>

impl Client

pub fn get_query_status_workload_insights_top_contributors( &self, ) -> GetQueryStatusWorkloadInsightsTopContributorsFluentBuilder

Constructs a fluent builder for the GetQueryStatusWorkloadInsightsTopContributors operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with GetQueryStatusWorkloadInsightsTopContributorsOutput with field(s):
  • status(QueryStatus):

    When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.

    • QUEUED: The query is scheduled to run.

    • RUNNING: The query is in progress but not complete.

    • SUCCEEDED: The query completed sucessfully.

    • FAILED: The query failed due to an error.

    • CANCELED: The query was canceled.

• On failure, responds with SdkError<GetQueryStatusWorkloadInsightsTopContributorsError>

impl Client

pub fn get_query_status_workload_insights_top_contributors_data( &self, ) -> GetQueryStatusWorkloadInsightsTopContributorsDataFluentBuilder

Constructs a fluent builder for the GetQueryStatusWorkloadInsightsTopContributorsData operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with GetQueryStatusWorkloadInsightsTopContributorsDataOutput with field(s):
  • status(QueryStatus):

    The status of a query for top contributors data.

    • QUEUED: The query is scheduled to run.

    • RUNNING: The query is in progress but not complete.

    • SUCCEEDED: The query completed sucessfully.

    • FAILED: The query failed due to an error.

    • CANCELED: The query was canceled.

• On failure, responds with SdkError<GetQueryStatusWorkloadInsightsTopContributorsDataError>

impl Client

pub fn get_scope(&self) -> GetScopeFluentBuilder

Constructs a fluent builder for the GetScope operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

    
    
• On success, responds with GetScopeOutput with field(s):
  • scope_id(String):

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

  • status(ScopeStatus):

    The status of a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.

  • scope_arn(String):

    The Amazon Resource Name (ARN) of the scope.

  • targets(Vec::<TargetResource>):

    The targets for a scope

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

    The tags for a scope.

• On failure, responds with SdkError<GetScopeError>

impl Client

pub fn list_monitors(&self) -> ListMonitorsFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. You receive this token from a previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of query results that you want to return with this call.

    
    
  • monitor_status(MonitorStatus) / set_monitor_status(Option<MonitorStatus>):
    required: false
    

    The status of a monitor. The status can be one of the following

    • PENDING: The monitor is in the process of being created.

    • ACTIVE: The monitor is active.

    • INACTIVE: The monitor is inactive.

    • ERROR: Monitor creation failed due to an error.

    • DELETING: The monitor is in the process of being deleted.

    
    
• On success, responds with ListMonitorsOutput with field(s):
  • monitors(Vec::<MonitorSummary>):

    The monitors that are in an account.

  • next_token(Option<String>):

    The token for the next set of results. You receive this token from a previous call.

• On failure, responds with SdkError<ListMonitorsError>

impl Client

pub fn list_scopes(&self) -> ListScopesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results. You receive this token from a previous call.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of query results that you want to return with this call.

    
    
• On success, responds with ListScopesOutput with field(s):
  • scopes(Vec::<ScopeSummary>):

    The scopes returned by the call.

  • next_token(Option<String>):

    The token for the next set of results. You receive this token from a previous call.

• On failure, responds with SdkError<ListScopesError>

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 tags for a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_query_monitor_top_contributors( &self, ) -> StartQueryMonitorTopContributorsFluentBuilder

Constructs a fluent builder for the StartQueryMonitorTopContributors operation.

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

    The name of the monitor.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

    
    
  • metric_name(MonitorMetric) / set_metric_name(Option<MonitorMetric>):
    required: true
    

    The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

    
    
  • destination_category(DestinationCategory) / set_destination_category(Option<DestinationCategory>):
    required: true
    

    The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:

    • INTRA_AZ: Top contributor network flows within a single Availability Zone

    • INTER_AZ: Top contributor network flows between Availability Zones

    • INTER_VPC: Top contributor network flows between VPCs

    • AMAZON_S3: Top contributor network flows to or from Amazon S3

    • AMAZON_DYNAMODB: Top contributor network flows to or from Amazon Dynamo DB

    • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of top contributors to return.

    
    
• On success, responds with StartQueryMonitorTopContributorsOutput with field(s):
  • query_id(String):

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

• On failure, responds with SdkError<StartQueryMonitorTopContributorsError>

impl Client

pub fn start_query_workload_insights_top_contributors( &self, ) -> StartQueryWorkloadInsightsTopContributorsFluentBuilder

Constructs a fluent builder for the StartQueryWorkloadInsightsTopContributors operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a CreateScope API call.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

    
    
  • metric_name(WorkloadInsightsMetric) / set_metric_name(Option<WorkloadInsightsMetric>):
    required: true
    

    The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

    
    
  • destination_category(DestinationCategory) / set_destination_category(Option<DestinationCategory>):
    required: true
    

    The destination category for a top contributors row. Destination categories can be one of the following:

    • INTRA_AZ: Top contributor network flows within a single Availability Zone

    • INTER_AZ: Top contributor network flows between Availability Zones

    • INTER_VPC: Top contributor network flows between VPCs

    • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

    • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of top contributors to return.

    
    
• On success, responds with StartQueryWorkloadInsightsTopContributorsOutput with field(s):
  • query_id(String):

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

• On failure, responds with SdkError<StartQueryWorkloadInsightsTopContributorsError>

impl Client

pub fn start_query_workload_insights_top_contributors_data( &self, ) -> StartQueryWorkloadInsightsTopContributorsDataFluentBuilder

Constructs a fluent builder for the StartQueryWorkloadInsightsTopContributorsData operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time beginning of the period that you want to retrieve results for with your query.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

    
    
  • metric_name(WorkloadInsightsMetric) / set_metric_name(Option<WorkloadInsightsMetric>):
    required: true
    

    The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

    
    
  • destination_category(DestinationCategory) / set_destination_category(Option<DestinationCategory>):
    required: true
    

    The destination category for a top contributors. Destination categories can be one of the following:

    • INTRA_AZ: Top contributor network flows within a single Availability Zone

    • INTER_AZ: Top contributor network flows between Availability Zones

    • INTER_VPC: Top contributor network flows between VPCs

    • AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services

    • UNCLASSIFIED: Top contributor network flows that do not have a bucket classification

    
    
• On success, responds with StartQueryWorkloadInsightsTopContributorsDataOutput with field(s):
  • query_id(String):

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

• On failure, responds with SdkError<StartQueryWorkloadInsightsTopContributorsDataError>

impl Client

pub fn stop_query_monitor_top_contributors( &self, ) -> StopQueryMonitorTopContributorsFluentBuilder

Constructs a fluent builder for the StopQueryMonitorTopContributors operation.

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

    The name of the monitor.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with StopQueryMonitorTopContributorsOutput
• On failure, responds with SdkError<StopQueryMonitorTopContributorsError>

impl Client

pub fn stop_query_workload_insights_top_contributors( &self, ) -> StopQueryWorkloadInsightsTopContributorsFluentBuilder

Constructs a fluent builder for the StopQueryWorkloadInsightsTopContributors operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with StopQueryWorkloadInsightsTopContributorsOutput
• On failure, responds with SdkError<StopQueryWorkloadInsightsTopContributorsError>

impl Client

pub fn stop_query_workload_insights_top_contributors_data( &self, ) -> StopQueryWorkloadInsightsTopContributorsDataFluentBuilder

Constructs a fluent builder for the StopQueryWorkloadInsightsTopContributorsData operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • query_id(impl Into<String>) / set_query_id(Option<String>):
    required: true
    

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    
    
• On success, responds with StopQueryWorkloadInsightsTopContributorsDataOutput
• On failure, responds with SdkError<StopQueryWorkloadInsightsTopContributorsDataError>

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 tags for a 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
    

    Keys that you specified when you tagged a resource.

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

impl Client

pub fn update_monitor(&self) -> UpdateMonitorFluentBuilder

Constructs a fluent builder for the UpdateMonitor operation.

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

    The name of the monitor.

    
    
  • local_resources_to_add(MonitorLocalResource) / set_local_resources_to_add(Option<Vec::<MonitorLocalResource>>):
    required: false
    

    The local resources to add, as an array of resources with identifiers and types.

    
    
  • local_resources_to_remove(MonitorLocalResource) / set_local_resources_to_remove(Option<Vec::<MonitorLocalResource>>):
    required: false
    

    The local resources to remove, as an array of resources with identifiers and types.

    
    
  • remote_resources_to_add(MonitorRemoteResource) / set_remote_resources_to_add(Option<Vec::<MonitorRemoteResource>>):
    required: false
    

    The remove resources to add, as an array of resources with identifiers and types.

    
    
  • remote_resources_to_remove(MonitorRemoteResource) / set_remote_resources_to_remove(Option<Vec::<MonitorRemoteResource>>):
    required: false
    

    The remove resources to remove, as an array of resources with identifiers and types.

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

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

    
    
• On success, responds with UpdateMonitorOutput with field(s):
  • monitor_arn(String):

    The Amazon Resource Name (ARN) of the monitor.

  • monitor_name(String):

    The name of the monitor.

  • monitor_status(MonitorStatus):

    The status of a monitor. The status can be one of the following

    • PENDING: The monitor is in the process of being created.

    • ACTIVE: The monitor is active.

    • INACTIVE: The monitor is inactive.

    • ERROR: Monitor creation failed due to an error.

    • DELETING: The monitor is in the process of being deleted.

  • local_resources(Vec::<MonitorLocalResource>):

    The local resources updated for a monitor, as an array of resources with identifiers and types.

  • remote_resources(Vec::<MonitorRemoteResource>):

    The remote resources updated for a monitor, as an array of resources with identifiers and types.

  • created_at(DateTime):

    The date and time when the monitor was created.

  • modified_at(DateTime):

    The last date and time that the monitor was modified.

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

    The tags for a monitor.

• On failure, responds with SdkError<UpdateMonitorError>

impl Client

pub fn update_scope(&self) -> UpdateScopeFluentBuilder

Constructs a fluent builder for the UpdateScope operation.

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

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

    
    
  • resources_to_add(TargetResource) / set_resources_to_add(Option<Vec::<TargetResource>>):
    required: false
    

    A list of resources to add to a scope.

    
    
  • resources_to_delete(TargetResource) / set_resources_to_delete(Option<Vec::<TargetResource>>):
    required: false
    

    A list of resources to delete from a scope.

    
    
• On success, responds with UpdateScopeOutput with field(s):
  • scope_id(String):

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • status(ScopeStatus):

    The status for a call to update a scope. The status can be one of the following: SUCCEEDED, IN_PROGRESS, or FAILED.

  • scope_arn(String):

    The Amazon Resource Name (ARN) of the scope.

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

    The tags for a scope.

• On failure, responds with SdkError<UpdateScopeError>

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.