aws_sdk_applicationsignals/client/list_service_dependents.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListServiceDependents`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`start_time(DateTime)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::set_start_time):<br>required: **true**<br><p>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: <code>1698778057</code></p> <p>Your requested start time will be rounded to the nearest hour.</p><br>
8 /// - [`end_time(DateTime)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::set_end_time):<br>required: **true**<br><p>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: <code>1698778057</code></p> <p>Your requested start time will be rounded to the nearest hour.</p><br>
9 /// - [`key_attributes(impl Into<String>, impl Into<String>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::key_attributes) / [`set_key_attributes(Option<HashMap::<String, String>>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::set_key_attributes):<br>required: **true**<br><p>Use this field to specify which service you want to retrieve information for. You must specify at least the <code>Type</code>, <code>Name</code>, and <code>Environment</code> attributes.</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>
10 /// - [`max_results(i32)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::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>
11 /// - [`next_token(impl Into<String>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::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 dependents.</p><br>
12 /// - On success, responds with [`ListServiceDependentsOutput`](crate::operation::list_service_dependents::ListServiceDependentsOutput) with field(s):
13 /// - [`start_time(DateTime)`](crate::operation::list_service_dependents::ListServiceDependentsOutput::start_time): <p>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: <code>1698778057</code></p> <p>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.</p>
14 /// - [`end_time(DateTime)`](crate::operation::list_service_dependents::ListServiceDependentsOutput::end_time): <p>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: <code>1698778057</code></p> <p>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.</p>
15 /// - [`service_dependents(Vec::<ServiceDependent>)`](crate::operation::list_service_dependents::ListServiceDependentsOutput::service_dependents): <p>An array, where each object in the array contains information about one of the dependents of this service.</p>
16 /// - [`next_token(Option<String>)`](crate::operation::list_service_dependents::ListServiceDependentsOutput::next_token): <p>Include this value in your next use of this API to get next set of service dependents.</p>
17 /// - On failure, responds with [`SdkError<ListServiceDependentsError>`](crate::operation::list_service_dependents::ListServiceDependentsError)
18 pub fn list_service_dependents(&self) -> crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder {
19 crate::operation::list_service_dependents::builders::ListServiceDependentsFluentBuilder::new(self.handle.clone())
20 }
21}