aws_sdk_applicationsignals/client/

get_service.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetService`](crate::operation::get_service::builders::GetServiceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`start_time(DateTime)`](crate::operation::get_service::builders::GetServiceFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::get_service::builders::GetServiceFluentBuilder::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>
    ///   - [`end_time(DateTime)`](crate::operation::get_service::builders::GetServiceFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::get_service::builders::GetServiceFluentBuilder::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>
    ///   - [`key_attributes(impl Into<String>, impl Into<String>)`](crate::operation::get_service::builders::GetServiceFluentBuilder::key_attributes) / [`set_key_attributes(Option<HashMap::<String, String>>)`](crate::operation::get_service::builders::GetServiceFluentBuilder::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>
    /// - On success, responds with [`GetServiceOutput`](crate::operation::get_service::GetServiceOutput) with field(s):
    ///   - [`service(Option<Service>)`](crate::operation::get_service::GetServiceOutput::service): <p>A structure containing information about the service.</p>
    ///   - [`start_time(DateTime)`](crate::operation::get_service::GetServiceOutput::start_time): <p>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: <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>
    ///   - [`end_time(DateTime)`](crate::operation::get_service::GetServiceOutput::end_time): <p>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: <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>
    ///   - [`log_group_references(Option<Vec::<HashMap::<String, String>>>)`](crate::operation::get_service::GetServiceOutput::log_group_references): <p>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:</p> <ul>  <li>   <p><code>"Type": "AWS::Resource"</code></p></li>  <li>   <p><code>"ResourceType": "AWS::Logs::LogGroup"</code></p></li>  <li>   <p><code>"Identifier": "<i>name-of-log-group</i>"</code></p></li> </ul>
    /// - On failure, responds with [`SdkError<GetServiceError>`](crate::operation::get_service::GetServiceError)
    pub fn get_service(&self) -> crate::operation::get_service::builders::GetServiceFluentBuilder {
        crate::operation::get_service::builders::GetServiceFluentBuilder::new(self.handle.clone())
    }
}