Struct aws_sdk_cloudwatchlogs::Client

pub struct Client { /* private fields */ }

Client for Amazon CloudWatch Logs

Client for invoking operations on Amazon CloudWatch Logs. Each operation on Amazon CloudWatch Logs 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_cloudwatchlogs::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_cloudwatchlogs::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 AssociateKmsKey operation has a Client::associate_kms_key, 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.associate_kms_key()
    .log_group_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 associate_kms_key(&self) -> AssociateKmsKeyFluentBuilder

Constructs a fluent builder for the AssociateKmsKey operation.

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

    The name of the log group.

    In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can’t specify both.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. This must be a symmetric KMS key. For more information, see Amazon Resource Names and Using Symmetric and Asymmetric Keys.

    
    
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: false
    

    Specifies the target for this operation. You must specify one of the following:

    • Specify the following ARN to have future GetQueryResults operations in this account encrypt the results with the specified KMS key. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:query-result:*

    • Specify the ARN of a log group to have CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME

    In your AssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can’t specify both.

    
    
• On success, responds with AssociateKmsKeyOutput
• On failure, responds with SdkError<AssociateKmsKeyError>

impl Client

pub fn cancel_export_task(&self) -> CancelExportTaskFluentBuilder

Constructs a fluent builder for the CancelExportTask operation.

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

    The ID of the export task.

    
    
• On success, responds with CancelExportTaskOutput
• On failure, responds with SdkError<CancelExportTaskError>

impl Client

pub fn create_delivery(&self) -> CreateDeliveryFluentBuilder

Constructs a fluent builder for the CreateDelivery operation.

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

    The name of the delivery source to use for this delivery.

    
    
  • delivery_destination_arn(impl Into<String>) / set_delivery_destination_arn(Option<String>):
    required: true
    

    The ARN of the delivery destination to use for this delivery.

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

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

    For more information about tagging, see Tagging Amazon Web Services resources

    
    
• On success, responds with CreateDeliveryOutput with field(s):
  • delivery(Option<Delivery>):

    A structure that contains information about the delivery that you just created.

• On failure, responds with SdkError<CreateDeliveryError>

impl Client

pub fn create_export_task(&self) -> CreateExportTaskFluentBuilder

Constructs a fluent builder for the CreateExportTask operation.

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

    The name of the export task.

    
    
  • log_group_name(impl Into<String>) / set_log_group_name(Option<String>):
    required: true
    

    The name of the log group.

    
    
  • log_stream_name_prefix(impl Into<String>) / set_log_stream_name_prefix(Option<String>):
    required: false
    

    Export only log streams that match the provided prefix. If you don’t specify a value, no prefix filter is applied.

    
    
  • from(i64) / set_from(Option<i64>):
    required: true
    

    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

    
    
  • to(i64) / set_to(Option<i64>):
    required: true
    

    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

    You must specify a time that is not earlier than when this log group was created.

    
    
  • destination(impl Into<String>) / set_destination(Option<String>):
    required: true
    

    The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

    
    
  • destination_prefix(impl Into<String>) / set_destination_prefix(Option<String>):
    required: false
    

    The prefix used as the start of the key for every object exported. If you don’t specify a value, the default is exportedlogs.

    
    
• On success, responds with CreateExportTaskOutput with field(s):
  • task_id(Option<String>):

    The ID of the export task.

• On failure, responds with SdkError<CreateExportTaskError>

impl Client

pub fn create_log_anomaly_detector( &self ) -> CreateLogAnomalyDetectorFluentBuilder

Constructs a fluent builder for the CreateLogAnomalyDetector operation.

• The fluent builder is configurable:
  • log_group_arn_list(impl Into<String>) / set_log_group_arn_list(Option<Vec::<String>>):
    required: true
    

    An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.

    
    
  • detector_name(impl Into<String>) / set_detector_name(Option<String>):
    required: false
    

    A name for this anomaly detector.

    
    
  • evaluation_frequency(EvaluationFrequency) / set_evaluation_frequency(Option<EvaluationFrequency>):
    required: false
    

    Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .

    
    
  • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):
    required: false
    

    You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

    For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector.

    
    
  • anomaly_visibility_time(i64) / set_anomaly_visibility_time(Option<i64>):
    required: false
    

    The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal going forward and will not be detected as an anomaly.

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

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

    For more information about tagging, see Tagging Amazon Web Services resources

    
    
• On success, responds with CreateLogAnomalyDetectorOutput with field(s):
  • anomaly_detector_arn(Option<String>):

    The ARN of the log anomaly detector that you just created.

• On failure, responds with SdkError<CreateLogAnomalyDetectorError>

impl Client

pub fn create_log_group(&self) -> CreateLogGroupFluentBuilder

Constructs a fluent builder for the CreateLogGroup operation.

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

    A name for the log group.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.

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

    The key-value pairs to use for the tags.

    You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

    
    
  • log_group_class(LogGroupClass) / set_log_group_class(Option<LogGroupClass>):
    required: false
    

    Use this parameter to specify the log group class for this log group. There are two classes:

    • The Standard log class supports all CloudWatch Logs features.

    • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

    If you omit this parameter, the default of STANDARD is used.

    The value of logGroupClass can’t be changed after a log group is created.

    For details about the features supported by each class, see Log classes

    
    
• On success, responds with CreateLogGroupOutput
• On failure, responds with SdkError<CreateLogGroupError>

impl Client

pub fn create_log_stream(&self) -> CreateLogStreamFluentBuilder

Constructs a fluent builder for the CreateLogStream operation.

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

    The name of the log group.

    
    
  • log_stream_name(impl Into<String>) / set_log_stream_name(Option<String>):
    required: true
    

    The name of the log stream.

    
    
• On success, responds with CreateLogStreamOutput
• On failure, responds with SdkError<CreateLogStreamError>

impl Client

pub fn delete_account_policy(&self) -> DeleteAccountPolicyFluentBuilder

Constructs a fluent builder for the DeleteAccountPolicy operation.

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

    The name of the policy to delete.

    
    
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    The type of policy to delete.

    
    
• On success, responds with DeleteAccountPolicyOutput
• On failure, responds with SdkError<DeleteAccountPolicyError>

impl Client

pub fn delete_data_protection_policy( &self ) -> DeleteDataProtectionPolicyFluentBuilder

Constructs a fluent builder for the DeleteDataProtectionPolicy operation.

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

    The name or ARN of the log group that you want to delete the data protection policy for.

    
    
• On success, responds with DeleteDataProtectionPolicyOutput
• On failure, responds with SdkError<DeleteDataProtectionPolicyError>

impl Client

pub fn delete_delivery(&self) -> DeleteDeliveryFluentBuilder

Constructs a fluent builder for the DeleteDelivery operation.

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

    The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.

    
    
• On success, responds with DeleteDeliveryOutput
• On failure, responds with SdkError<DeleteDeliveryError>

impl Client

pub fn delete_delivery_destination( &self ) -> DeleteDeliveryDestinationFluentBuilder

Constructs a fluent builder for the DeleteDeliveryDestination operation.

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

    The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the DescribeDeliveryDestinations operation.

    
    
• On success, responds with DeleteDeliveryDestinationOutput
• On failure, responds with SdkError<DeleteDeliveryDestinationError>

impl Client

pub fn delete_delivery_destination_policy( &self ) -> DeleteDeliveryDestinationPolicyFluentBuilder

Constructs a fluent builder for the DeleteDeliveryDestinationPolicy operation.

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

    The name of the delivery destination that you want to delete the policy for.

    
    
• On success, responds with DeleteDeliveryDestinationPolicyOutput
• On failure, responds with SdkError<DeleteDeliveryDestinationPolicyError>

impl Client

pub fn delete_delivery_source(&self) -> DeleteDeliverySourceFluentBuilder

Constructs a fluent builder for the DeleteDeliverySource operation.

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

    The name of the delivery source that you want to delete.

    
    
• On success, responds with DeleteDeliverySourceOutput
• On failure, responds with SdkError<DeleteDeliverySourceError>

impl Client

pub fn delete_destination(&self) -> DeleteDestinationFluentBuilder

Constructs a fluent builder for the DeleteDestination operation.

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

    The name of the destination.

    
    
• On success, responds with DeleteDestinationOutput
• On failure, responds with SdkError<DeleteDestinationError>

impl Client

pub fn delete_log_anomaly_detector( &self ) -> DeleteLogAnomalyDetectorFluentBuilder

Constructs a fluent builder for the DeleteLogAnomalyDetector operation.

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

    The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

    
    
• On success, responds with DeleteLogAnomalyDetectorOutput
• On failure, responds with SdkError<DeleteLogAnomalyDetectorError>

impl Client

pub fn delete_log_group(&self) -> DeleteLogGroupFluentBuilder

Constructs a fluent builder for the DeleteLogGroup operation.

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

    The name of the log group.

    
    
• On success, responds with DeleteLogGroupOutput
• On failure, responds with SdkError<DeleteLogGroupError>

impl Client

pub fn delete_log_stream(&self) -> DeleteLogStreamFluentBuilder

Constructs a fluent builder for the DeleteLogStream operation.

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

    The name of the log group.

    
    
  • log_stream_name(impl Into<String>) / set_log_stream_name(Option<String>):
    required: true
    

    The name of the log stream.

    
    
• On success, responds with DeleteLogStreamOutput
• On failure, responds with SdkError<DeleteLogStreamError>

impl Client

pub fn delete_metric_filter(&self) -> DeleteMetricFilterFluentBuilder

Constructs a fluent builder for the DeleteMetricFilter operation.

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

    The name of the log group.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    The name of the metric filter.

    
    
• On success, responds with DeleteMetricFilterOutput
• On failure, responds with SdkError<DeleteMetricFilterError>

impl Client

pub fn delete_query_definition(&self) -> DeleteQueryDefinitionFluentBuilder

Constructs a fluent builder for the DeleteQueryDefinition operation.

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

    The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

    
    
• On success, responds with DeleteQueryDefinitionOutput with field(s):
  • success(bool):

    A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.

• On failure, responds with SdkError<DeleteQueryDefinitionError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

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

    The name of the policy to be revoked. This parameter is required.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn delete_retention_policy(&self) -> DeleteRetentionPolicyFluentBuilder

Constructs a fluent builder for the DeleteRetentionPolicy operation.

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

    The name of the log group.

    
    
• On success, responds with DeleteRetentionPolicyOutput
• On failure, responds with SdkError<DeleteRetentionPolicyError>

impl Client

pub fn delete_subscription_filter( &self ) -> DeleteSubscriptionFilterFluentBuilder

Constructs a fluent builder for the DeleteSubscriptionFilter operation.

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

    The name of the log group.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    The name of the subscription filter.

    
    
• On success, responds with DeleteSubscriptionFilterOutput
• On failure, responds with SdkError<DeleteSubscriptionFilterError>

impl Client

pub fn describe_account_policies(&self) -> DescribeAccountPoliciesFluentBuilder

Constructs a fluent builder for the DescribeAccountPolicies operation.

• The fluent builder is configurable:
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.

    
    
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: false
    

    Use this parameter to limit the returned policies to only the policy with the name that you specify.

    
    
  • account_identifiers(impl Into<String>) / set_account_identifiers(Option<Vec::<String>>):
    required: false
    

    If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

    If you omit this parameter, only the policy in the current account is returned.

    
    
• On success, responds with DescribeAccountPoliciesOutput with field(s):
  • account_policies(Option<Vec::<AccountPolicy>>):

    An array of structures that contain information about the CloudWatch Logs account policies that match the specified filters.

• On failure, responds with SdkError<DescribeAccountPoliciesError>

impl Client

pub fn describe_deliveries(&self) -> DescribeDeliveriesFluentBuilder

Constructs a fluent builder for the DescribeDeliveries 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 items to return. The token expires after 24 hours.

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

    Optionally specify the maximum number of deliveries to return in the response.

    
    
• On success, responds with DescribeDeliveriesOutput with field(s):
  • deliveries(Option<Vec::<Delivery>>):

    An array of structures. Each structure contains information about one delivery in the account.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeDeliveriesError>

impl Client

pub fn describe_delivery_destinations( &self ) -> DescribeDeliveryDestinationsFluentBuilder

Constructs a fluent builder for the DescribeDeliveryDestinations 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 items to return. The token expires after 24 hours.

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

    Optionally specify the maximum number of delivery destinations to return in the response.

    
    
• On success, responds with DescribeDeliveryDestinationsOutput with field(s):
  • delivery_destinations(Option<Vec::<DeliveryDestination>>):

    An array of structures. Each structure contains information about one delivery destination in the account.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeDeliveryDestinationsError>

impl Client

pub fn describe_delivery_sources(&self) -> DescribeDeliverySourcesFluentBuilder

Constructs a fluent builder for the DescribeDeliverySources 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 items to return. The token expires after 24 hours.

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

    Optionally specify the maximum number of delivery sources to return in the response.

    
    
• On success, responds with DescribeDeliverySourcesOutput with field(s):
  • delivery_sources(Option<Vec::<DeliverySource>>):

    An array of structures. Each structure contains information about one delivery source in the account.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeDeliverySourcesError>

impl Client

pub fn describe_destinations(&self) -> DescribeDestinationsFluentBuilder

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

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

    The prefix to match. If you don’t specify a value, no prefix filter is applied.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default maximum value of 50 items is used.

    
    
• On success, responds with DescribeDestinationsOutput with field(s):
  • destinations(Option<Vec::<Destination>>):

    The destinations.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeDestinationsError>

impl Client

pub fn describe_export_tasks(&self) -> DescribeExportTasksFluentBuilder

Constructs a fluent builder for the DescribeExportTasks operation.

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

    The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.

    
    
  • status_code(ExportTaskStatusCode) / set_status_code(Option<ExportTaskStatusCode>):
    required: false
    

    The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

    
    
• On success, responds with DescribeExportTasksOutput with field(s):
  • export_tasks(Option<Vec::<ExportTask>>):

    The export tasks.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeExportTasksError>

impl Client

pub fn describe_log_groups(&self) -> DescribeLogGroupsFluentBuilder

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

• The fluent builder is configurable:
  • account_identifiers(impl Into<String>) / set_account_identifiers(Option<Vec::<String>>):
    required: false
    

    When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

    
    
  • log_group_name_prefix(impl Into<String>) / set_log_group_name_prefix(Option<String>):
    required: false
    

    The prefix to match.

    logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

    
    
  • log_group_name_pattern(impl Into<String>) / set_log_group_name_pattern(Option<String>):
    required: false
    

    If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

    If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

    logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

    
    
  • include_linked_accounts(bool) / set_include_linked_accounts(Option<bool>):
    required: false
    

    If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

    If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

    
    
  • log_group_class(LogGroupClass) / set_log_group_class(Option<LogGroupClass>):
    required: false
    

    Specifies the log group class for this log group. There are two classes:

    • The Standard log class supports all CloudWatch Logs features.

    • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

    For details about the features supported by each class, see Log classes

    
    
• On success, responds with DescribeLogGroupsOutput with field(s):
  • log_groups(Option<Vec::<LogGroup>>):

    The log groups.

    If the retentionInDays value is not included for a log group, then that log group’s events do not expire.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeLogGroupsError>

impl Client

pub fn describe_log_streams(&self) -> DescribeLogStreamsFluentBuilder

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

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

    The name of the log group.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_group_identifier(impl Into<String>) / set_log_group_identifier(Option<String>):
    required: false
    

    Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_stream_name_prefix(impl Into<String>) / set_log_stream_name_prefix(Option<String>):
    required: false
    

    The prefix to match.

    If orderBy is LastEventTime, you cannot specify this parameter.

    
    
  • order_by(OrderBy) / set_order_by(Option<OrderBy>):
    required: false
    

    If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

    If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

    lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

    
    
  • descending(bool) / set_descending(Option<bool>):
    required: false
    

    If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

    
    
• On success, responds with DescribeLogStreamsOutput with field(s):
  • log_streams(Option<Vec::<LogStream>>):

    The log streams.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeLogStreamsError>

impl Client

pub fn describe_metric_filters(&self) -> DescribeMetricFiltersFluentBuilder

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

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

    The name of the log group.

    
    
  • filter_name_prefix(impl Into<String>) / set_filter_name_prefix(Option<String>):
    required: false
    

    The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: false
    

    Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

    
    
  • metric_namespace(impl Into<String>) / set_metric_namespace(Option<String>):
    required: false
    

    Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.

    
    
• On success, responds with DescribeMetricFiltersOutput with field(s):
  • metric_filters(Option<Vec::<MetricFilter>>):

    The metric filters.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeMetricFiltersError>

impl Client

pub fn describe_queries(&self) -> DescribeQueriesFluentBuilder

Constructs a fluent builder for the DescribeQueries operation.

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

    Limits the returned queries to only those for the specified log group.

    
    
  • status(QueryStatus) / set_status(Option<QueryStatus>):
    required: false
    

    Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

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

    Limits the number of returned queries to the specified number.

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

    The token for the next set of items to return. The token expires after 24 hours.

    
    
• On success, responds with DescribeQueriesOutput with field(s):
  • queries(Option<Vec::<QueryInfo>>):

    The list of queries that match the request.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeQueriesError>

impl Client

pub fn describe_query_definitions( &self ) -> DescribeQueryDefinitionsFluentBuilder

Constructs a fluent builder for the DescribeQueryDefinitions operation.

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

    Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

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

    Limits the number of returned query definitions to the specified number.

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

    The token for the next set of items to return. The token expires after 24 hours.

    
    
• On success, responds with DescribeQueryDefinitionsOutput with field(s):
  • query_definitions(Option<Vec::<QueryDefinition>>):

    The list of query definitions that match your request.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeQueryDefinitionsError>

impl Client

pub fn describe_resource_policies( &self ) -> DescribeResourcePoliciesFluentBuilder

Constructs a fluent builder for the DescribeResourcePolicies operation.

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

    The token for the next set of items to return. The token expires after 24 hours.

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

    The maximum number of resource policies to be displayed with one call of this API.

    
    
• On success, responds with DescribeResourcePoliciesOutput with field(s):
  • resource_policies(Option<Vec::<ResourcePolicy>>):

    The resource policies that exist in this account.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeResourcePoliciesError>

impl Client

pub fn describe_subscription_filters( &self ) -> DescribeSubscriptionFiltersFluentBuilder

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

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

    The name of the log group.

    
    
  • filter_name_prefix(impl Into<String>) / set_filter_name_prefix(Option<String>):
    required: false
    

    The prefix to match. If you don’t specify a value, no prefix filter is applied.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

    
    
• On success, responds with DescribeSubscriptionFiltersOutput with field(s):
  • subscription_filters(Option<Vec::<SubscriptionFilter>>):

    The subscription filters.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<DescribeSubscriptionFiltersError>

impl Client

pub fn disassociate_kms_key(&self) -> DisassociateKmsKeyFluentBuilder

Constructs a fluent builder for the DisassociateKmsKey operation.

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

    The name of the log group.

    In your DisassociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can’t specify both.

    
    
  • resource_identifier(impl Into<String>) / set_resource_identifier(Option<String>):
    required: false
    

    Specifies the target for this operation. You must specify one of the following:

    • Specify the ARN of a log group to stop having CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME

    • Specify the following ARN to stop using this key to encrypt the results of future StartQuery operations in this account. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:query-result:*

    In your DisssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can’t specify both.

    
    
• On success, responds with DisassociateKmsKeyOutput
• On failure, responds with SdkError<DisassociateKmsKeyError>

impl Client

pub fn filter_log_events(&self) -> FilterLogEventsFluentBuilder

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

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

    The name of the log group to search.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_group_identifier(impl Into<String>) / set_log_group_identifier(Option<String>):
    required: false
    

    Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_stream_names(impl Into<String>) / set_log_stream_names(Option<Vec::<String>>):
    required: false
    

    Filters the results to only logs from the log streams in this list.

    If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

    
    
  • log_stream_name_prefix(impl Into<String>) / set_log_stream_name_prefix(Option<String>):
    required: false
    

    Filters the results to include only events from log streams that have names starting with this prefix.

    If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

    
    
  • start_time(i64) / set_start_time(Option<i64>):
    required: false
    

    The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

    
    
  • end_time(i64) / set_end_time(Option<i64>):
    required: false
    

    The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

    
    
  • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):
    required: false
    

    The filter pattern to use. For more information, see Filter and Pattern Syntax.

    If not provided, all the events are matched.

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

    The token for the next set of events to return. (You received this token from a previous call.)

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

    The maximum number of events to return. The default is 10,000 events.

    
    
  • interleaved(bool) / set_interleaved(Option<bool>):
    required: false
    

    If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

    Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

    
    
  • unmask(bool) / set_unmask(Option<bool>):
    required: false
    

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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

    The matched events.

  • searched_log_streams(Option<Vec::<SearchedLogStream>>):

    Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

    Indicates which log streams have been searched and whether each has been searched completely.

  • next_token(Option<String>):

    The token to use when requesting the next set of items. The token expires after 24 hours.

• On failure, responds with SdkError<FilterLogEventsError>

impl Client

pub fn get_data_protection_policy(&self) -> GetDataProtectionPolicyFluentBuilder

Constructs a fluent builder for the GetDataProtectionPolicy operation.

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

    The name or ARN of the log group that contains the data protection policy that you want to see.

    
    
• On success, responds with GetDataProtectionPolicyOutput with field(s):
  • log_group_identifier(Option<String>):

    The log group name or ARN that you specified in your request.

  • policy_document(Option<String>):

    The data protection policy document for this log group.

  • last_updated_time(Option<i64>):

    The date and time that this policy was most recently updated.

• On failure, responds with SdkError<GetDataProtectionPolicyError>

impl Client

pub fn get_delivery(&self) -> GetDeliveryFluentBuilder

Constructs a fluent builder for the GetDelivery operation.

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

    The ID of the delivery that you want to retrieve.

    
    
• On success, responds with GetDeliveryOutput with field(s):
  • delivery(Option<Delivery>):

    A structure that contains information about the delivery.

• On failure, responds with SdkError<GetDeliveryError>

impl Client

pub fn get_delivery_destination(&self) -> GetDeliveryDestinationFluentBuilder

Constructs a fluent builder for the GetDeliveryDestination operation.

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

    The name of the delivery destination that you want to retrieve.

    
    
• On success, responds with GetDeliveryDestinationOutput with field(s):
  • delivery_destination(Option<DeliveryDestination>):

    A structure containing information about the delivery destination.

• On failure, responds with SdkError<GetDeliveryDestinationError>

impl Client

pub fn get_delivery_destination_policy( &self ) -> GetDeliveryDestinationPolicyFluentBuilder

Constructs a fluent builder for the GetDeliveryDestinationPolicy operation.

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

    The name of the delivery destination that you want to retrieve the policy of.

    
    
• On success, responds with GetDeliveryDestinationPolicyOutput with field(s):
  • policy(Option<Policy>):

    The IAM policy for this delivery destination.

• On failure, responds with SdkError<GetDeliveryDestinationPolicyError>

impl Client

pub fn get_delivery_source(&self) -> GetDeliverySourceFluentBuilder

Constructs a fluent builder for the GetDeliverySource operation.

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

    The name of the delivery source that you want to retrieve.

    
    
• On success, responds with GetDeliverySourceOutput with field(s):
  • delivery_source(Option<DeliverySource>):

    A structure containing information about the delivery source.

• On failure, responds with SdkError<GetDeliverySourceError>

impl Client

pub fn get_log_anomaly_detector(&self) -> GetLogAnomalyDetectorFluentBuilder

Constructs a fluent builder for the GetLogAnomalyDetector operation.

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

    The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

    
    
• On success, responds with GetLogAnomalyDetectorOutput with field(s):
  • detector_name(Option<String>):

    The name of the log anomaly detector

  • log_group_arn_list(Option<Vec::<String>>):

    An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

  • evaluation_frequency(Option<EvaluationFrequency>):

    Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

  • filter_pattern(Option<String>):

    A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

  • anomaly_detector_status(Option<AnomalyDetectorStatus>):

    Specifies whether the anomaly detector is currently active. To change its status, use the enabled parameter in the UpdateLogAnomalyDetector operation.

  • kms_key_id(Option<String>):

    The ID of the KMS key assigned to this anomaly detector, if any.

  • creation_time_stamp(i64):

    The date and time when this anomaly detector was created.

  • last_modified_time_stamp(i64):

    The date and time when this anomaly detector was most recently modified.

  • anomaly_visibility_time(Option<i64>):

    The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

• On failure, responds with SdkError<GetLogAnomalyDetectorError>

impl Client

pub fn get_log_events(&self) -> GetLogEventsFluentBuilder

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

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

    The name of the log group.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_group_identifier(impl Into<String>) / set_log_group_identifier(Option<String>):
    required: false
    

    Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • log_stream_name(impl Into<String>) / set_log_stream_name(Option<String>):
    required: true
    

    The name of the log stream.

    
    
  • start_time(i64) / set_start_time(Option<i64>):
    required: false
    

    The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

    
    
  • end_time(i64) / set_end_time(Option<i64>):
    required: false
    

    The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of log events returned. If you don’t specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).

    
    
  • start_from_head(bool) / set_start_from_head(Option<bool>):
    required: false
    

    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

    If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

    
    
  • unmask(bool) / set_unmask(Option<bool>):
    required: false
    

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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

    The events.

  • next_forward_token(Option<String>):

    The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it returns the same token you passed in.

  • next_backward_token(Option<String>):

    The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.

• On failure, responds with SdkError<GetLogEventsError>

impl Client

pub fn get_log_group_fields(&self) -> GetLogGroupFieldsFluentBuilder

Constructs a fluent builder for the GetLogGroupFields operation.

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

    The name of the log group to search.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
  • time(i64) / set_time(Option<i64>):
    required: false
    

    The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

    The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

    
    
  • log_group_identifier(impl Into<String>) / set_log_group_identifier(Option<String>):
    required: false
    

    Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

    You must include either logGroupIdentifier or logGroupName, but not both.

    
    
• On success, responds with GetLogGroupFieldsOutput with field(s):
  • log_group_fields(Option<Vec::<LogGroupField>>):

    The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

• On failure, responds with SdkError<GetLogGroupFieldsError>

impl Client

pub fn get_log_record(&self) -> GetLogRecordFluentBuilder

Constructs a fluent builder for the GetLogRecord operation.

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

    The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.

    
    
  • unmask(bool) / set_unmask(Option<bool>):
    required: false
    

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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

    The requested log event, as a JSON string.

• On failure, responds with SdkError<GetLogRecordError>

impl Client

pub fn get_query_results(&self) -> GetQueryResultsFluentBuilder

Constructs a fluent builder for the GetQueryResults operation.

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

    The ID number of the query.

    
    
• On success, responds with GetQueryResultsOutput with field(s):
  • results(Option<Vec::<Vec::<ResultField>>>):

    The log events that matched the query criteria during the most recent time it ran.

    The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

  • statistics(Option<QueryStatistics>):

    Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

  • status(Option<QueryStatus>):

    The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

    Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

  • encryption_key(Option<String>):

    If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that’s used to encrypt the query results when StartQuery stores them.

• On failure, responds with SdkError<GetQueryResultsError>

impl Client

pub fn list_anomalies(&self) -> ListAnomaliesFluentBuilder

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

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

    Use this to optionally limit the results to only the anomalies found by a certain anomaly detector.

    
    
  • suppression_state(SuppressionState) / set_suppression_state(Option<SuppressionState>):
    required: false
    

    You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed.

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

    The maximum number of items to return. If you don’t specify a value, the default maximum value of 50 items is used.

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

    The token for the next set of items to return. The token expires after 24 hours.

    
    
• On success, responds with ListAnomaliesOutput with field(s):
  • anomalies(Option<Vec::<Anomaly>>):

    An array of structures, where each structure contains information about one anomaly that a log anomaly detector has found.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<ListAnomaliesError>

impl Client

pub fn list_log_anomaly_detectors(&self) -> ListLogAnomalyDetectorsFluentBuilder

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

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

    Use this to optionally filter the results to only include anomaly detectors that are associated with the specified log group.

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

    The maximum number of items to return. If you don’t specify a value, the default maximum value of 50 items is used.

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

    The token for the next set of items to return. The token expires after 24 hours.

    
    
• On success, responds with ListLogAnomalyDetectorsOutput with field(s):
  • anomaly_detectors(Option<Vec::<AnomalyDetector>>):

    An array of structures, where each structure in the array contains information about one anomaly detector.

  • next_token(Option<String>):

    The token for the next set of items to return. The token expires after 24 hours.

• On failure, responds with SdkError<ListLogAnomalyDetectorsError>

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 ARN of the resource that you want to view tags for.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

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

    The list of tags associated with the requested resource.>

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tags_log_group(&self) -> ListTagsLogGroupFluentBuilder

👎Deprecated: Please use the generic tagging API ListTagsForResource

Constructs a fluent builder for the ListTagsLogGroup operation.

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

    The name of the log group.

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

    The tags for the log group.

• On failure, responds with SdkError<ListTagsLogGroupError>

impl Client

pub fn put_account_policy(&self) -> PutAccountPolicyFluentBuilder

Constructs a fluent builder for the PutAccountPolicy operation.

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

    A name for the policy. This must be unique within the account.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: true
    

    Specify the policy, in JSON.

    Data protection policy

    A data protection policy must include two JSON blocks:

    • The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

      The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.

    • The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.

      The Operation property with the Deidentify action is what actually masks the data, and it must contain the “MaskConfig”: {} object. The “MaskConfig”: {} object must be empty.

    For an example data protection policy, see the Examples section on this page.

    The contents of the two DataIdentifer arrays must match exactly.

    In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is different than the operation’s policyName parameter, and is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

    The JSON specified in policyDocument can be up to 30,720 characters long.

    Subscription filter policy

    A subscription filter policy can include the following attributes in a JSON block:

    • DestinationArn The ARN of the destination to deliver log events to. Supported destinations are:

      • An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.

      • An Firehose data stream in the same account as the subscription policy, for same-account delivery.

      • A Lambda function in the same account as the subscription policy, for same-account delivery.

      • A logical destination in a different account created with PutDestination, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.

    • RoleArn The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don’t need to provide the ARN when you are working with a logical destination for cross-account delivery.

    • FilterPattern A filter pattern for subscribing to a filtered stream of log events.

    • DistributionThe method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to Random for a more even distribution. This property is only applicable when the destination is an Kinesis Data Streams data stream.

    
    
  • policy_type(PolicyType) / set_policy_type(Option<PolicyType>):
    required: true
    

    The type of policy that you’re creating or updating.

    
    
  • scope(Scope) / set_scope(Option<Scope>):
    required: false
    

    Currently the only valid value for this parameter is ALL, which specifies that the data protection policy applies to all log groups in the account. If you omit this parameter, the default of ALL is used.

    
    
  • selection_criteria(impl Into<String>) / set_selection_criteria(Option<String>):
    required: false
    

    Use this parameter to apply the subscription filter policy to a subset of log groups in the account. Currently, the only supported filter is LogGroupName NOT IN []. The selectionCriteria string can be up to 25KB in length. The length is determined by using its UTF-8 bytes.

    Using the selectionCriteria parameter is useful to help prevent infinite loops. For more information, see Log recursion prevention.

    Specifing selectionCriteria is valid only when you specify SUBSCRIPTION_FILTER_POLICY for policyType.

    
    
• On success, responds with PutAccountPolicyOutput with field(s):
  • account_policy(Option<AccountPolicy>):

    The account policy that you created.

• On failure, responds with SdkError<PutAccountPolicyError>

impl Client

pub fn put_data_protection_policy(&self) -> PutDataProtectionPolicyFluentBuilder

Constructs a fluent builder for the PutDataProtectionPolicy operation.

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

    Specify either the log group name or log group ARN.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: true
    

    Specify the data protection policy, in JSON.

    This policy must include two JSON blocks:

    • The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

      The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Firehose streams, and S3 buckets, they must already exist.

    • The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.

      The Operation property with the Deidentify action is what actually masks the data, and it must contain the “MaskConfig”: {} object. The “MaskConfig”: {} object must be empty.

    For an example data protection policy, see the Examples section on this page.

    The contents of the two DataIdentifer arrays must match exactly.

    In addition to the two JSON blocks, the policyDocument can also include Name, Description, and Version fields. The Name is used as a dimension when CloudWatch Logs reports audit findings metrics to CloudWatch.

    The JSON specified in policyDocument can be up to 30,720 characters.

    
    
• On success, responds with PutDataProtectionPolicyOutput with field(s):
  • log_group_identifier(Option<String>):

    The log group name or ARN that you specified in your request.

  • policy_document(Option<String>):

    The data protection policy used for this log group.

  • last_updated_time(Option<i64>):

    The date and time that this policy was most recently updated.

• On failure, responds with SdkError<PutDataProtectionPolicyError>

impl Client

pub fn put_delivery_destination(&self) -> PutDeliveryDestinationFluentBuilder

Constructs a fluent builder for the PutDeliveryDestination operation.

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

    A name for this delivery destination. This name must be unique for all delivery destinations in your account.

    
    
  • output_format(OutputFormat) / set_output_format(Option<OutputFormat>):
    required: false
    

    The format for the logs that this delivery destination will receive.

    
    
  • delivery_destination_configuration(DeliveryDestinationConfiguration) / set_delivery_destination_configuration(Option<DeliveryDestinationConfiguration>):
    required: true
    

    A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

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

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

    For more information about tagging, see Tagging Amazon Web Services resources

    
    
• On success, responds with PutDeliveryDestinationOutput with field(s):
  • delivery_destination(Option<DeliveryDestination>):

    A structure containing information about the delivery destination that you just created or updated.

• On failure, responds with SdkError<PutDeliveryDestinationError>

impl Client

pub fn put_delivery_destination_policy( &self ) -> PutDeliveryDestinationPolicyFluentBuilder

Constructs a fluent builder for the PutDeliveryDestinationPolicy operation.

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

    The name of the delivery destination to assign this policy to.

    
    
  • delivery_destination_policy(impl Into<String>) / set_delivery_destination_policy(Option<String>):
    required: true
    

    The contents of the policy.

    
    
• On success, responds with PutDeliveryDestinationPolicyOutput with field(s):
  • policy(Option<Policy>):

    The contents of the policy that you just created.

• On failure, responds with SdkError<PutDeliveryDestinationPolicyError>

impl Client

pub fn put_delivery_source(&self) -> PutDeliverySourceFluentBuilder

Constructs a fluent builder for the PutDeliverySource operation.

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

    A name for this delivery source. This name must be unique for all delivery sources in your account.

    
    
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the Amazon Web Services resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234

    
    
  • log_type(impl Into<String>) / set_log_type(Option<String>):
    required: true
    

    Defines the type of log that the source is sending.

    • For Amazon CodeWhisperer, the valid value is EVENT_LOGS.

    • For IAM Identity Centerr, the valid value is ERROR_LOGS.

    • For Amazon WorkMail, the valid values are ACCESS_CONTROL_LOGS, AUTHENTICATION_LOGS, WORKMAIL_AVAILABILITY_PROVIDER_LOGS, and WORKMAIL_MAILBOX_ACCESS_LOGS.

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

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

    For more information about tagging, see Tagging Amazon Web Services resources

    
    
• On success, responds with PutDeliverySourceOutput with field(s):
  • delivery_source(Option<DeliverySource>):

    A structure containing information about the delivery source that was just created or updated.

• On failure, responds with SdkError<PutDeliverySourceError>

impl Client

pub fn put_destination(&self) -> PutDestinationFluentBuilder

Constructs a fluent builder for the PutDestination operation.

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

    A name for the destination.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The ARN of an Amazon Kinesis stream to which to deliver matching log events.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

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

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

    For more information about tagging, see Tagging Amazon Web Services resources

    
    
• On success, responds with PutDestinationOutput with field(s):
  • destination(Option<Destination>):

    The destination.

• On failure, responds with SdkError<PutDestinationError>

impl Client

pub fn put_destination_policy(&self) -> PutDestinationPolicyFluentBuilder

Constructs a fluent builder for the PutDestinationPolicy operation.

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

    A name for an existing destination.

    
    
  • access_policy(impl Into<String>) / set_access_policy(Option<String>):
    required: true
    

    An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination. This can be up to 5120 bytes.

    
    
  • force_update(bool) / set_force_update(Option<bool>):
    required: false
    

    Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual Amazon Web Services accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

    If you omit this parameter, the default of false is used.

    
    
• On success, responds with PutDestinationPolicyOutput
• On failure, responds with SdkError<PutDestinationPolicyError>

impl Client

pub fn put_log_events(&self) -> PutLogEventsFluentBuilder

Constructs a fluent builder for the PutLogEvents operation.

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

    The name of the log group.

    
    
  • log_stream_name(impl Into<String>) / set_log_stream_name(Option<String>):
    required: true
    

    The name of the log stream.

    
    
  • log_events(InputLogEvent) / set_log_events(Option<Vec::<InputLogEvent>>):
    required: true
    

    The log events.

    
    
  • sequence_token(impl Into<String>) / set_sequence_token(Option<String>):
    required: false
    

    The sequence token obtained from the response of the previous PutLogEvents call.

    The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

    
    
• On success, responds with PutLogEventsOutput with field(s):
  • next_sequence_token(Option<String>):

    The next sequence token.

    This field has been deprecated.

    The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream and you do not need to wait for the response of a previous PutLogEvents action to obtain the nextSequenceToken value.

  • rejected_log_events_info(Option<RejectedLogEventsInfo>):

    The rejected events.

• On failure, responds with SdkError<PutLogEventsError>

impl Client

pub fn put_metric_filter(&self) -> PutMetricFilterFluentBuilder

Constructs a fluent builder for the PutMetricFilter operation.

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

    The name of the log group.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    A name for the metric filter.

    
    
  • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):
    required: true
    

    A filter pattern for extracting metric data out of ingested log events.

    
    
  • metric_transformations(MetricTransformation) / set_metric_transformations(Option<Vec::<MetricTransformation>>):
    required: true
    

    A collection of information that defines how metric data gets emitted.

    
    
• On success, responds with PutMetricFilterOutput
• On failure, responds with SdkError<PutMetricFilterError>

impl Client

pub fn put_query_definition(&self) -> PutQueryDefinitionFluentBuilder

Constructs a fluent builder for the PutQueryDefinition operation.

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

    A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

    
    
  • query_definition_id(impl Into<String>) / set_query_definition_id(Option<String>):
    required: false
    

    If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

    If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

    
    
  • log_group_names(impl Into<String>) / set_log_group_names(Option<Vec::<String>>):
    required: false
    

    Use this parameter to include specific log groups as part of your query definition.

    If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

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

    Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network error.

    
    
• On success, responds with PutQueryDefinitionOutput with field(s):
  • query_definition_id(Option<String>):

    The ID of the query definition.

• On failure, responds with SdkError<PutQueryDefinitionError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

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

    Name of the new policy. This parameter is required.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: false
    

    Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

    The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace “logArn” with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

    CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

    In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.

    { “Version”: “2012-10-17”, “Statement”: [ { “Sid”: “Route53LogsToCloudWatchLogs”, “Effect”: “Allow”, “Principal”: { “Service”: [ “route53.amazonaws.com” ] }, “Action”: “logs:PutLogEvents”, “Resource”: “logArn”, “Condition”: { “ArnLike”: { “aws:SourceArn”: “myRoute53ResourceArn” }, “StringEquals”: { “aws:SourceAccount”: “myAwsAccountId” } } } ] }

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    The new policy.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn put_retention_policy(&self) -> PutRetentionPolicyFluentBuilder

Constructs a fluent builder for the PutRetentionPolicy operation.

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

    The name of the log group.

    
    
  • retention_in_days(i32) / set_retention_in_days(Option<i32>):
    required: true
    

    The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.

    To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

    
    
• On success, responds with PutRetentionPolicyOutput
• On failure, responds with SdkError<PutRetentionPolicyError>

impl Client

pub fn put_subscription_filter(&self) -> PutSubscriptionFilterFluentBuilder

Constructs a fluent builder for the PutSubscriptionFilter operation.

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

    The name of the log group.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

    
    
  • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):
    required: true
    

    A filter pattern for subscribing to a filtered stream of log events.

    
    
  • destination_arn(impl Into<String>) / set_destination_arn(Option<String>):
    required: true
    

    The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

    • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

    • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

      If you’re setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

    • A Kinesis Data Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

    • A Lambda function belonging to the same account as the subscription filter, for same-account delivery.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don’t need to provide the ARN when you are working with a logical destination for cross-account delivery.

    
    
  • distribution(Distribution) / set_distribution(Option<Distribution>):
    required: false
    

    The method used to distribute log data to the destination. By default, log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis data stream.

    
    
• On success, responds with PutSubscriptionFilterOutput
• On failure, responds with SdkError<PutSubscriptionFilterError>

impl Client

pub fn start_query(&self) -> StartQueryFluentBuilder

Constructs a fluent builder for the StartQuery operation.

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

    The log group on which to perform the query.

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

    
    
  • log_group_names(impl Into<String>) / set_log_group_names(Option<Vec::<String>>):
    required: false
    

    The list of log groups to be queried. You can include up to 50 log groups.

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

    
    
  • log_group_identifiers(impl Into<String>) / set_log_group_identifiers(Option<Vec::<String>>):
    required: false
    

    The list of log groups to query. You can include up to 50 log groups.

    You can specify them by the log group name or ARN. If a log group that you’re querying is in a source account and you’re using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

    If you specify an ARN, the ARN can’t end with an asterisk (*).

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

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

    The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

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

    The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

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

    The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

    
    
• On success, responds with StartQueryOutput with field(s):
  • query_id(Option<String>):

    The unique ID of the query.

• On failure, responds with SdkError<StartQueryError>

impl Client

pub fn stop_query(&self) -> StopQueryFluentBuilder

Constructs a fluent builder for the StopQuery operation.

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

    The ID number of the query to stop. To find this ID number, use DescribeQueries.

    
    
• On success, responds with StopQueryOutput with field(s):
  • success(bool):

    This is true if the query was stopped by the StopQuery operation.

• On failure, responds with SdkError<StopQueryError>

impl Client

pub fn tag_log_group(&self) -> TagLogGroupFluentBuilder

👎Deprecated: Please use the generic tagging API TagResource

Constructs a fluent builder for the TagLogGroup operation.

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

    The name of the log group.

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

    The key-value pairs to use for the tags.

    
    
• On success, responds with TagLogGroupOutput
• On failure, responds with SdkError<TagLogGroupError>

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 ARN of the resource that you’re adding tags to.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

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

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

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

impl Client

pub fn test_metric_filter(&self) -> TestMetricFilterFluentBuilder

Constructs a fluent builder for the TestMetricFilter operation.

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

    A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

    
    
  • log_event_messages(impl Into<String>) / set_log_event_messages(Option<Vec::<String>>):
    required: true
    

    The log event messages to test.

    
    
• On success, responds with TestMetricFilterOutput with field(s):
  • matches(Option<Vec::<MetricFilterMatchRecord>>):

    The matched events.

• On failure, responds with SdkError<TestMetricFilterError>

impl Client

pub fn untag_log_group(&self) -> UntagLogGroupFluentBuilder

👎Deprecated: Please use the generic tagging API UntagResource

Constructs a fluent builder for the UntagLogGroup operation.

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

    The name of the log group.

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

    The tag keys. The corresponding tags are removed from the log group.

    
    
• On success, responds with UntagLogGroupOutput
• On failure, responds with SdkError<UntagLogGroupError>

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 ARN of the CloudWatch Logs resource that you’re removing tags from.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

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

    The list of tag keys to remove from the resource.

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

impl Client

pub fn update_anomaly(&self) -> UpdateAnomalyFluentBuilder

Constructs a fluent builder for the UpdateAnomaly operation.

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

    If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by using the ListAnomalies operation.

    
    
  • pattern_id(impl Into<String>) / set_pattern_id(Option<String>):
    required: false
    

    If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by using the ListAnomalies operation.

    
    
  • anomaly_detector_arn(impl Into<String>) / set_anomaly_detector_arn(Option<String>):
    required: true
    

    The ARN of the anomaly detector that this operation is to act on.

    
    
  • suppression_type(SuppressionType) / set_suppression_type(Option<SuppressionType>):
    required: false
    

    Use this to specify whether the suppression to be temporary or infinite. If you specify LIMITED, you must also specify a suppressionPeriod. If you specify INFINITE, any value for suppressionPeriod is ignored.

    
    
  • suppression_period(SuppressionPeriod) / set_suppression_period(Option<SuppressionPeriod>):
    required: false
    

    If you are temporarily suppressing an anomaly or pattern, use this structure to specify how long the suppression is to last.

    
    
• On success, responds with UpdateAnomalyOutput
• On failure, responds with SdkError<UpdateAnomalyError>

impl Client

pub fn update_log_anomaly_detector( &self ) -> UpdateLogAnomalyDetectorFluentBuilder

Constructs a fluent builder for the UpdateLogAnomalyDetector operation.

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

    The ARN of the anomaly detector that you want to update.

    
    
  • evaluation_frequency(EvaluationFrequency) / set_evaluation_frequency(Option<EvaluationFrequency>):
    required: false
    

    Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

    
    
  • filter_pattern(impl Into<String>) / set_filter_pattern(Option<String>):
    required: false
    

    A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

    
    
  • anomaly_visibility_time(i64) / set_anomaly_visibility_time(Option<i64>):
    required: false
    

    The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an anomaly during this time, it will be considered normal going forward and will not be detected.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: true
    

    Use this parameter to pause or restart the anomaly detector.

    
    
• On success, responds with UpdateLogAnomalyDetectorOutput
• On failure, responds with SdkError<UpdateLogAnomalyDetectorError>

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.