Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon CloudWatch Application Signals

Client for invoking operations on Amazon CloudWatch Application Signals. Each operation on Amazon CloudWatch Application Signals 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_applicationsignals::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_applicationsignals::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 CreateServiceLevelObjective operation has a Client::create_service_level_objective, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_service_level_objective()
    .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 batch_get_service_level_objective_budget_report( &self, ) -> BatchGetServiceLevelObjectiveBudgetReportFluentBuilder

Constructs a fluent builder for the BatchGetServiceLevelObjectiveBudgetReport operation.

• The fluent builder is configurable:
  • timestamp(DateTime) / set_timestamp(Option<DateTime>):
    required: true
    

    The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

    
    
  • slo_ids(impl Into<String>) / set_slo_ids(Option<Vec::<String>>):
    required: true
    

    An array containing the IDs of the service level objectives that you want to include in the report.

    
    
• On success, responds with BatchGetServiceLevelObjectiveBudgetReportOutput with field(s):
  • timestamp(DateTime):

    The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

  • reports(Vec::<ServiceLevelObjectiveBudgetReport>):

    An array of structures, where each structure is one budget report.

  • errors(Vec::<ServiceLevelObjectiveBudgetReportError>):

    An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.

• On failure, responds with SdkError<BatchGetServiceLevelObjectiveBudgetReportError>

impl Client

pub fn batch_update_exclusion_windows( &self, ) -> BatchUpdateExclusionWindowsFluentBuilder

Constructs a fluent builder for the BatchUpdateExclusionWindows operation.

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

    The list of SLO IDs to add or remove exclusion windows from.

    
    
  • add_exclusion_windows(ExclusionWindow) / set_add_exclusion_windows(Option<Vec::<ExclusionWindow>>):
    required: false
    

    A list of exclusion windows to add to the specified SLOs. You can add up to 10 exclusion windows per SLO.

    
    
  • remove_exclusion_windows(ExclusionWindow) / set_remove_exclusion_windows(Option<Vec::<ExclusionWindow>>):
    required: false
    

    A list of exclusion windows to remove from the specified SLOs. The window configuration must match an existing exclusion window.

    
    
• On success, responds with BatchUpdateExclusionWindowsOutput with field(s):
  • slo_ids(Vec::<String>):

    The list of SLO IDs that were successfully processed.

  • errors(Vec::<BatchUpdateExclusionWindowsError>):

    A list of errors that occurred while processing the request.

• On failure, responds with SdkError<BatchUpdateExclusionWindowsError>

impl Client

pub fn create_service_level_objective( &self, ) -> CreateServiceLevelObjectiveFluentBuilder

Constructs a fluent builder for the CreateServiceLevelObjective operation.

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

    A name for this SLO.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for this SLO.

    
    
  • sli_config(ServiceLevelIndicatorConfig) / set_sli_config(Option<ServiceLevelIndicatorConfig>):
    required: false
    

    If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can’t specify both RequestBasedSliConfig and SliConfig in the same operation.

    
    
  • request_based_sli_config(RequestBasedServiceLevelIndicatorConfig) / set_request_based_sli_config(Option<RequestBasedServiceLevelIndicatorConfig>):
    required: false
    

    If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can’t specify both RequestBasedSliConfig and SliConfig in the same operation.

    
    
  • goal(Goal) / set_goal(Option<Goal>):
    required: false
    

    This structure contains the attributes that determine the goal of the SLO.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the cloudwatch:TagResource permission.

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

    
    
  • burn_rate_configurations(BurnRateConfiguration) / set_burn_rate_configurations(Option<Vec::<BurnRateConfiguration>>):
    required: false
    

    Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

    
    
• On success, responds with CreateServiceLevelObjectiveOutput with field(s):
  • slo(Option<ServiceLevelObjective>):

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

• On failure, responds with SdkError<CreateServiceLevelObjectiveError>

impl Client

pub fn delete_grouping_configuration( &self, ) -> DeleteGroupingConfigurationFluentBuilder

Constructs a fluent builder for the DeleteGroupingConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteGroupingConfigurationOutput
• On failure, responds with SdkError<DeleteGroupingConfigurationError>

impl Client

pub fn delete_service_level_objective( &self, ) -> DeleteServiceLevelObjectiveFluentBuilder

Constructs a fluent builder for the DeleteServiceLevelObjective operation.

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

    The ARN or name of the service level objective to delete.

    
    
• On success, responds with DeleteServiceLevelObjectiveOutput
• On failure, responds with SdkError<DeleteServiceLevelObjectiveError>

impl Client

pub fn get_service(&self) -> GetServiceFluentBuilder

Constructs a fluent builder for the GetService operation.

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

    
    
  • key_attributes(impl Into<String>, impl Into<String>) / set_key_attributes(Option<HashMap::<String, String>>):
    required: true
    

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

    
    
• On success, responds with GetServiceOutput with field(s):
  • service(Option<Service>):

    A structure containing information about the service.

  • start_time(DateTime):

    The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • end_time(DateTime):

    The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • log_group_references(Option<Vec::<HashMap::<String, String>>>):

    An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

    • “Type”: “AWS::Resource”

    • “ResourceType”: “AWS::Logs::LogGroup”

    • “Identifier”: “name-of-log-group”

• On failure, responds with SdkError<GetServiceError>

impl Client

pub fn get_service_level_objective( &self, ) -> GetServiceLevelObjectiveFluentBuilder

Constructs a fluent builder for the GetServiceLevelObjective operation.

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

    The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.

    
    
• On success, responds with GetServiceLevelObjectiveOutput with field(s):
  • slo(Option<ServiceLevelObjective>):

    A structure containing the information about the SLO.

• On failure, responds with SdkError<GetServiceLevelObjectiveError>

impl Client

pub fn list_audit_findings(&self) -> ListAuditFindingsFluentBuilder

Constructs a fluent builder for the ListAuditFindings operation.

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start time for the audit findings query. Only findings created on or after this time will be included in the results. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

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

    The end time for the audit findings query. Only findings created before this time will be included in the results. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

    
    
  • auditors(impl Into<String>) / set_auditors(Option<Vec::<String>>):
    required: false
    

    An array of auditor names to filter the findings. Only findings generated by the specified auditors will be returned. When not specified, findings from all auditors are included except canary.

    
    
  • audit_targets(AuditTarget) / set_audit_targets(Option<Vec::<AuditTarget>>):
    required: true
    

    An array of audit target specifications to filter the findings. Only findings related to the specified targets (such as specific services, SLOs, operations or canary) will be returned.

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

    The token for the next set of results. Use this token to retrieve additional pages of audit findings when the result set is large.

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

    The maximum number of audit findings to return in a single request. Valid range is 1 to 100. If not specified, defaults to 50.

    
    
• On success, responds with ListAuditFindingsOutput with field(s):
  • audit_findings(Vec::<AuditFinding>):

    An array of audit findings that match the specified criteria. Each finding includes details about the issue, affected resources, and auditor results.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.

• On failure, responds with SdkError<ListAuditFindingsError>

impl Client

pub fn list_grouping_attribute_definitions( &self, ) -> ListGroupingAttributeDefinitionsFluentBuilder

Constructs a fluent builder for the ListGroupingAttributeDefinitions 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 results. Use this token to retrieve additional pages of grouping attribute definitions when the result set is large.

    
    
• On success, responds with ListGroupingAttributeDefinitionsOutput with field(s):
  • grouping_attribute_definitions(Vec::<GroupingAttributeDefinition>):

    An array of available grouping attribute definitions that can be used to create grouping configurations.

  • updated_at(Option<DateTime>):

    The timestamp when the grouping attribute definitions were last updated. Expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.

• On failure, responds with SdkError<ListGroupingAttributeDefinitionsError>

impl Client

pub fn list_service_dependencies(&self) -> ListServiceDependenciesFluentBuilder

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

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

    
    
  • key_attributes(impl Into<String>, impl Into<String>) / set_key_attributes(Option<HashMap::<String, String>>):
    required: true
    

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of service dependencies.

    
    
• On success, responds with ListServiceDependenciesOutput with field(s):
  • start_time(DateTime):

    The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • end_time(DateTime):

    The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • service_dependencies(Vec::<ServiceDependency>):

    An array, where each object in the array contains information about one of the dependencies of this service.

  • next_token(Option<String>):

    Include this value in your next use of this API to get next set of service dependencies.

• On failure, responds with SdkError<ListServiceDependenciesError>

impl Client

pub fn list_service_dependents(&self) -> ListServiceDependentsFluentBuilder

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

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

    
    
  • key_attributes(impl Into<String>, impl Into<String>) / set_key_attributes(Option<HashMap::<String, String>>):
    required: true
    

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of service dependents.

    
    
• On success, responds with ListServiceDependentsOutput with field(s):
  • start_time(DateTime):

    The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • end_time(DateTime):

    The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • service_dependents(Vec::<ServiceDependent>):

    An array, where each object in the array contains information about one of the dependents of this service.

  • next_token(Option<String>):

    Include this value in your next use of this API to get next set of service dependents.

• On failure, responds with SdkError<ListServiceDependentsError>

impl Client

pub fn list_service_level_objective_exclusion_windows( &self, ) -> ListServiceLevelObjectiveExclusionWindowsFluentBuilder

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

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

    The ID of the SLO to list exclusion windows for.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

    
    
• On success, responds with ListServiceLevelObjectiveExclusionWindowsOutput with field(s):
  • exclusion_windows(Vec::<ExclusionWindow>):

    A list of exclusion windows configured for the SLO.

  • next_token(Option<String>):

    Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

• On failure, responds with SdkError<ListServiceLevelObjectiveExclusionWindowsError>

impl Client

pub fn list_service_level_objectives( &self, ) -> ListServiceLevelObjectivesFluentBuilder

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

• The fluent builder is configurable:
  • key_attributes(impl Into<String>, impl Into<String>) / set_key_attributes(Option<HashMap::<String, String>>):
    required: false
    

    You can use this optional field to specify which services you want to retrieve SLO information for.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

    
    
  • operation_name(impl Into<String>) / set_operation_name(Option<String>):
    required: false
    

    The name of the operation that this SLO is associated with.

    
    
  • dependency_config(DependencyConfig) / set_dependency_config(Option<DependencyConfig>):
    required: false
    

    Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

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

    If you are using this operation in a monitoring account, specify true to include SLO from source accounts in the returned data.

    When you are monitoring an account, you can use Amazon Web Services account ID in KeyAttribute filter for service source account and SloOwnerawsaccountID for SLO source account with IncludeLinkedAccounts to filter the returned data to only a single source account.

    
    
  • slo_owner_aws_account_id(impl Into<String>) / set_slo_owner_aws_account_id(Option<String>):
    required: false
    

    SLO’s Amazon Web Services account ID.

    
    
  • metric_source_types(MetricSourceType) / set_metric_source_types(Option<Vec::<MetricSourceType>>):
    required: false
    

    Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:

    • Service operation

    • Service dependency

    • CloudWatch metric

    
    
• On success, responds with ListServiceLevelObjectivesOutput with field(s):
  • slo_summaries(Option<Vec::<ServiceLevelObjectiveSummary>>):

    An array of structures, where each structure contains information about one SLO.

  • next_token(Option<String>):

    Include this value in your next use of this API to get next set of service level objectives.

• On failure, responds with SdkError<ListServiceLevelObjectivesError>

impl Client

pub fn list_service_operations(&self) -> ListServiceOperationsFluentBuilder

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

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested end time will be rounded to the nearest hour.

    
    
  • key_attributes(impl Into<String>, impl Into<String>) / set_key_attributes(Option<HashMap::<String, String>>):
    required: true
    

    Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment attributes.

    This is a string-to-string map. It can include the following fields.

    • Type designates the type of object this is.

    • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

    • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

    • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

    • Environment specifies the location where this object is hosted, or what it belongs to.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of service operations.

    
    
• On success, responds with ListServiceOperationsOutput with field(s):
  • start_time(DateTime):

    The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • end_time(DateTime):

    The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • service_operations(Vec::<ServiceOperation>):

    An array of structures that each contain information about one operation of this service.

  • next_token(Option<String>):

    Include this value in your next use of this API to get next set of service operations.

• On failure, responds with SdkError<ListServiceOperationsError>

impl Client

pub fn list_service_states(&self) -> ListServiceStatesFluentBuilder

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

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start time for the service states query. Only service states from this time onward will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

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

    The end time for the service states query. Only service states before this time will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

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

    The maximum number of service states to return in a single request. Valid range is 1 to 100. If not specified, defaults to 50.

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

    The token for the next set of results. Use this token to retrieve additional pages of service states when the result set is large.

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

    Specifies whether to include service states from linked AWS accounts in the results. Set to true to include linked accounts, or false to only include the current account. Defaults to false.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    The AWS account ID to filter service states. If specified, only service states from this account will be returned. If not specified, service states from the current account (and linked accounts if enabled) are returned.

    
    
  • attribute_filters(AttributeFilter) / set_attribute_filters(Option<Vec::<AttributeFilter>>):
    required: false
    

    An array of attribute filters to narrow down the service states returned. Each filter specifies an attribute name and the values to match against.

    
    
• On success, responds with ListServiceStatesOutput with field(s):
  • start_time(DateTime):

    The start time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

  • end_time(DateTime):

    The end time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

  • service_states(Vec::<ServiceState>):

    An array of service state objects that match the specified criteria. Each service state includes current status, recent change events, and service metadata.

  • next_token(Option<String>):

    The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.

• On failure, responds with SdkError<ListServiceStatesError>

impl Client

pub fn list_services(&self) -> ListServicesFluentBuilder

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

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    Your requested start time will be rounded to the nearest hour.

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

    The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.

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

    Include this value, if it was returned by the previous operation, to get the next set of services.

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

    If you are using this operation in a monitoring account, specify true to include services from source accounts in the returned data.

    
    
  • aws_account_id(impl Into<String>) / set_aws_account_id(Option<String>):
    required: false
    

    Amazon Web Services Account ID.

    
    
• On success, responds with ListServicesOutput with field(s):
  • start_time(DateTime):

    The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • end_time(DateTime):

    The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

    This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.

  • service_summaries(Vec::<ServiceSummary>):

    An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.

  • next_token(Option<String>):

    Include this value in your next use of this API to get next set of services.

• On failure, responds with SdkError<ListServicesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

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

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

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_grouping_configuration( &self, ) -> PutGroupingConfigurationFluentBuilder

Constructs a fluent builder for the PutGroupingConfiguration operation.

• The fluent builder is configurable:
  • grouping_attribute_definitions(GroupingAttributeDefinition) / set_grouping_attribute_definitions(Option<Vec::<GroupingAttributeDefinition>>):
    required: true
    

    An array of grouping attribute definitions that specify how services should be grouped. Each definition includes the grouping name, source keys, and default values.

    
    
• On success, responds with PutGroupingConfigurationOutput with field(s):
  • grouping_configuration(Option<GroupingConfiguration>):

    The created or updated grouping configuration, including all attribute definitions and metadata such as the update timestamp.

• On failure, responds with SdkError<PutGroupingConfigurationError>

impl Client

pub fn start_discovery(&self) -> StartDiscoveryFluentBuilder

Constructs a fluent builder for the StartDiscovery operation.

• The fluent builder takes no input, just send it.
• On success, responds with StartDiscoveryOutput
• On failure, responds with SdkError<StartDiscoveryError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

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

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.

    The ARN format of an Application Signals SLO is arn:aws:cloudwatch:Region:account-id:slo:slo-name

    For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.

    
    
  • 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_service_level_objective( &self, ) -> UpdateServiceLevelObjectiveFluentBuilder

Constructs a fluent builder for the UpdateServiceLevelObjective operation.

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

    The Amazon Resource Name (ARN) or name of the service level objective that you want to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    An optional description for the SLO.

    
    
  • sli_config(ServiceLevelIndicatorConfig) / set_sli_config(Option<ServiceLevelIndicatorConfig>):
    required: false
    

    If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    
    
  • request_based_sli_config(RequestBasedServiceLevelIndicatorConfig) / set_request_based_sli_config(Option<RequestBasedServiceLevelIndicatorConfig>):
    required: false
    

    If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.

    You can’t specify both SliConfig and RequestBasedSliConfig in the same operation.

    
    
  • goal(Goal) / set_goal(Option<Goal>):
    required: false
    

    A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.

    
    
  • burn_rate_configurations(BurnRateConfiguration) / set_burn_rate_configurations(Option<Vec::<BurnRateConfiguration>>):
    required: false
    

    Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.

    
    
• On success, responds with UpdateServiceLevelObjectiveOutput with field(s):
  • slo(Option<ServiceLevelObjective>):

    A structure that contains information about the SLO that you just updated.

• On failure, responds with SdkError<UpdateServiceLevelObjectiveError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

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

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.