aws_sdk_applicationsignals/client/

list_service_level_objectives.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListServiceLevelObjectives`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`key_attributes(impl Into<String>, impl Into<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::key_attributes) / [`set_key_attributes(Option<HashMap::<String, String>>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_key_attributes):<br>required: **false**<br><p>You can use this optional field to specify which services you want to retrieve SLO information for.</p> <p>This is a string-to-string map. It can include the following fields.</p> <ul>  <li>   <p><code>Type</code> designates the type of object this is.</p></li>  <li>   <p><code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p></li>  <li>   <p><code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p></li>  <li>   <p><code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p></li>  <li>   <p><code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p></li> </ul><br>
    ///   - [`operation_name(impl Into<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::operation_name) / [`set_operation_name(Option<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_operation_name):<br>required: **false**<br><p>The name of the operation that this SLO is associated with.</p><br>
    ///   - [`dependency_config(DependencyConfig)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::dependency_config) / [`set_dependency_config(Option<DependencyConfig>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_dependency_config):<br>required: **false**<br><p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_next_token):<br>required: **false**<br><p>Include this value, if it was returned by the previous operation, to get the next set of service level objectives.</p><br>
    ///   - [`include_linked_accounts(bool)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::include_linked_accounts) / [`set_include_linked_accounts(Option<bool>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_include_linked_accounts):<br>required: **false**<br><p>If you are using this operation in a monitoring account, specify <code>true</code> to include SLO from source accounts in the returned data.</p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account.</p><br>
    ///   - [`slo_owner_aws_account_id(impl Into<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::slo_owner_aws_account_id) / [`set_slo_owner_aws_account_id(Option<String>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_slo_owner_aws_account_id):<br>required: **false**<br><p>SLO's Amazon Web Services account ID.</p><br>
    ///   - [`metric_source_types(MetricSourceType)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::metric_source_types) / [`set_metric_source_types(Option<Vec::<MetricSourceType>>)`](crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::set_metric_source_types):<br>required: **false**<br><p>Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:</p> <ul>  <li>   <p>Service operation</p></li>  <li>   <p>Service dependency</p></li>  <li>   <p>CloudWatch metric</p></li> </ul><br>
    /// - On success, responds with [`ListServiceLevelObjectivesOutput`](crate::operation::list_service_level_objectives::ListServiceLevelObjectivesOutput) with field(s):
    ///   - [`slo_summaries(Option<Vec::<ServiceLevelObjectiveSummary>>)`](crate::operation::list_service_level_objectives::ListServiceLevelObjectivesOutput::slo_summaries): <p>An array of structures, where each structure contains information about one SLO.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_service_level_objectives::ListServiceLevelObjectivesOutput::next_token): <p>Include this value in your next use of this API to get next set of service level objectives.</p>
    /// - On failure, responds with [`SdkError<ListServiceLevelObjectivesError>`](crate::operation::list_service_level_objectives::ListServiceLevelObjectivesError)
    pub fn list_service_level_objectives(
        &self,
    ) -> crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder {
        crate::operation::list_service_level_objectives::builders::ListServiceLevelObjectivesFluentBuilder::new(self.handle.clone())
    }
}