Struct aws_sdk_pinpoint::types::WriteSegmentRequest

#[non_exhaustive]
pub struct WriteSegmentRequest {
    pub dimensions: Option<SegmentDimensions>,
    pub name: Option<String>,
    pub segment_groups: Option<SegmentGroupList>,
    pub tags: Option<HashMap<String, String>>,
}

Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dimensions: Option<SegmentDimensions>

The criteria that define the dimensions for the segment.

name: Option<String>

The name of the segment.

segment_groups: Option<SegmentGroupList>

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

tags: Option<HashMap<String, String>>

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

Implementations

impl WriteSegmentRequest

pub fn dimensions(&self) -> Option<&SegmentDimensions>

The criteria that define the dimensions for the segment.

pub fn name(&self) -> Option<&str>

The name of the segment.

pub fn segment_groups(&self) -> Option<&SegmentGroupList>

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

pub fn tags(&self) -> Option<&HashMap<String, String>>

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

impl WriteSegmentRequest

pub fn builder() -> WriteSegmentRequestBuilder

Creates a new builder-style object to manufacture WriteSegmentRequest.

Trait Implementations

impl Clone for WriteSegmentRequest

fn clone(&self) -> WriteSegmentRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WriteSegmentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WriteSegmentRequest

fn eq(&self, other: &WriteSegmentRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WriteSegmentRequest