aws_sdk_pinpoint/client/

remove_attributes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`RemoveAttributes`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p><br>
    ///   - [`attribute_type(impl Into<String>)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::attribute_type) / [`set_attribute_type(Option<String>)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::set_attribute_type):<br>required: **true**<br><p>The type of attribute or attributes to remove. Valid values are:</p> <ul>  <li>   <p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li>  <li>   <p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li>  <li>   <p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li> </ul><br>
    ///   - [`update_attributes_request(UpdateAttributesRequest)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::update_attributes_request) / [`set_update_attributes_request(Option<UpdateAttributesRequest>)`](crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::set_update_attributes_request):<br>required: **true**<br><p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p><br>
    /// - On success, responds with [`RemoveAttributesOutput`](crate::operation::remove_attributes::RemoveAttributesOutput) with field(s):
    ///   - [`attributes_resource(Option<AttributesResource>)`](crate::operation::remove_attributes::RemoveAttributesOutput::attributes_resource): <p>Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.</p>
    /// - On failure, responds with [`SdkError<RemoveAttributesError>`](crate::operation::remove_attributes::RemoveAttributesError)
    pub fn remove_attributes(&self) -> crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder {
        crate::operation::remove_attributes::builders::RemoveAttributesFluentBuilder::new(self.handle.clone())
    }
}