aws_sdk_location/client/
put_geofence.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 [`PutGeofence`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`collection_name(impl Into<String>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::collection_name) / [`set_collection_name(Option<String>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::set_collection_name):<br>required: **true**<br><p>The geofence collection to store the geofence in.</p><br>
7    ///   - [`geofence_id(impl Into<String>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::geofence_id) / [`set_geofence_id(Option<String>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::set_geofence_id):<br>required: **true**<br><p>An identifier for the geofence. For example, <code>ExampleGeofence-1</code>.</p><br>
8    ///   - [`geometry(GeofenceGeometry)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::geometry) / [`set_geometry(Option<GeofenceGeometry>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::set_geometry):<br>required: **true**<br><p>Contains the details to specify the position of the geofence. Can be a circle, a polygon, or a multipolygon. <code>Polygon</code> and <code>MultiPolygon</code> geometries can be defined using their respective parameters, or encoded in Geobuf format using the <code>Geobuf</code> parameter. Including multiple geometry types in the same request will return a validation error.</p><note>  <p>The geofence <code>Polygon</code> and <code>MultiPolygon</code> formats support a maximum of 1,000 total vertices. The <code>Geobuf</code> format supports a maximum of 100,000 vertices.</p> </note><br>
9    ///   - [`geofence_properties(impl Into<String>, impl Into<String>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::geofence_properties) / [`set_geofence_properties(Option<HashMap::<String, String>>)`](crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::set_geofence_properties):<br>required: **false**<br><p>Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.</p> <p>Format: <code>"key" : "value"</code></p><br>
10    /// - On success, responds with [`PutGeofenceOutput`](crate::operation::put_geofence::PutGeofenceOutput) with field(s):
11    ///   - [`geofence_id(String)`](crate::operation::put_geofence::PutGeofenceOutput::geofence_id): <p>The geofence identifier entered in the request.</p>
12    ///   - [`create_time(DateTime)`](crate::operation::put_geofence::PutGeofenceOutput::create_time): <p>The timestamp for when the geofence 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>
13    ///   - [`update_time(DateTime)`](crate::operation::put_geofence::PutGeofenceOutput::update_time): <p>The timestamp for when the geofence 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>
14    /// - On failure, responds with [`SdkError<PutGeofenceError>`](crate::operation::put_geofence::PutGeofenceError)
15    pub fn put_geofence(&self) -> crate::operation::put_geofence::builders::PutGeofenceFluentBuilder {
16        crate::operation::put_geofence::builders::PutGeofenceFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_location/client/put_geofence.rs

aws_sdk_location/client/
put_geofence.rs
