aws_sdk_location/client/
describe_geofence_collection.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 [`DescribeGeofenceCollection`](crate::operation::describe_geofence_collection::builders::DescribeGeofenceCollectionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`collection_name(impl Into<String>)`](crate::operation::describe_geofence_collection::builders::DescribeGeofenceCollectionFluentBuilder::collection_name) / [`set_collection_name(Option<String>)`](crate::operation::describe_geofence_collection::builders::DescribeGeofenceCollectionFluentBuilder::set_collection_name):<br>required: **true**<br><p>The name of the geofence collection.</p><br>
7    /// - On success, responds with [`DescribeGeofenceCollectionOutput`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput) with field(s):
8    ///   - [`collection_name(String)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::collection_name): <p>The name of the geofence collection.</p>
9    ///   - [`collection_arn(String)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::collection_arn): <p>The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all Amazon Web Services.</p> <ul>  <li>   <p>Format example: <code>arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection</code></p></li> </ul>
10    ///   - [`description(String)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::description): <p>The optional description for the geofence collection.</p>
11    ///   - [`pricing_plan(Option<PricingPlan>)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::pricing_plan): <p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>
12    ///   - [`pricing_plan_data_source(Option<String>)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::pricing_plan_data_source): <p>No longer used. Always returns an empty string.</p>
13    ///   - [`kms_key_id(Option<String>)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::kms_key_id): <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a> assigned to the Amazon Location resource</p>
14    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::tags): <p>Displays the key, value pairs of tags associated with this resource.</p>
15    ///   - [`create_time(DateTime)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::create_time): <p>The timestamp for when the geofence resource was created in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code></p>
16    ///   - [`update_time(DateTime)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::update_time): <p>The timestamp for when the geofence collection was last updated in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code></p>
17    ///   - [`geofence_count(Option<i32>)`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionOutput::geofence_count): <p>The number of geofences in the geofence collection.</p>
18    /// - On failure, responds with [`SdkError<DescribeGeofenceCollectionError>`](crate::operation::describe_geofence_collection::DescribeGeofenceCollectionError)
19    pub fn describe_geofence_collection(&self) -> crate::operation::describe_geofence_collection::builders::DescribeGeofenceCollectionFluentBuilder {
20        crate::operation::describe_geofence_collection::builders::DescribeGeofenceCollectionFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_location/client/describe_geofence_collection.rs

aws_sdk_location/client/
describe_geofence_collection.rs
