Struct aws_sdk_chimesdkidentity::types::AppInstanceUserEndpoint

#[non_exhaustive]
pub struct AppInstanceUserEndpoint {
    pub app_instance_user_arn: Option<String>,
    pub endpoint_id: Option<String>,
    pub name: Option<String>,
    pub type: Option<AppInstanceUserEndpointType>,
    pub resource_arn: Option<String>,
    pub endpoint_attributes: Option<EndpointAttributes>,
    pub created_timestamp: Option<DateTime>,
    pub last_updated_timestamp: Option<DateTime>,
    pub allow_messages: Option<AllowMessages>,
    pub endpoint_state: Option<EndpointState>,
}

An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.

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.

app_instance_user_arn: Option<String>

The ARN of the AppInstanceUser.

endpoint_id: Option<String>

The unique identifier of the AppInstanceUserEndpoint.

name: Option<String>

The name of the AppInstanceUserEndpoint.

type: Option<AppInstanceUserEndpointType>

The type of the AppInstanceUserEndpoint.

resource_arn: Option<String>

The ARN of the resource to which the endpoint belongs.

endpoint_attributes: Option<EndpointAttributes>

The attributes of an Endpoint.

created_timestamp: Option<DateTime>

The time at which an AppInstanceUserEndpoint was created.

last_updated_timestamp: Option<DateTime>

The time at which an AppInstanceUserEndpoint was last updated.

allow_messages: Option<AllowMessages>

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

endpoint_state: Option<EndpointState>

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

• ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

• INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

• INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

• INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Implementations

impl AppInstanceUserEndpoint

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

The ARN of the AppInstanceUser.

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

The unique identifier of the AppInstanceUserEndpoint.

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

The name of the AppInstanceUserEndpoint.

pub fn type(&self) -> Option<&AppInstanceUserEndpointType>

The type of the AppInstanceUserEndpoint.

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

The ARN of the resource to which the endpoint belongs.

pub fn endpoint_attributes(&self) -> Option<&EndpointAttributes>

The attributes of an Endpoint.

pub fn created_timestamp(&self) -> Option<&DateTime>

The time at which an AppInstanceUserEndpoint was created.

pub fn last_updated_timestamp(&self) -> Option<&DateTime>

The time at which an AppInstanceUserEndpoint was last updated.

pub fn allow_messages(&self) -> Option<&AllowMessages>

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

pub fn endpoint_state(&self) -> Option<&EndpointState>

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

• ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

• INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

• INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

• INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

impl AppInstanceUserEndpoint

pub fn builder() -> AppInstanceUserEndpointBuilder

Creates a new builder-style object to manufacture AppInstanceUserEndpoint.

Trait Implementations

impl Clone for AppInstanceUserEndpoint

fn clone(&self) -> AppInstanceUserEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppInstanceUserEndpoint

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

Formats the value using the given formatter.

impl PartialEq for AppInstanceUserEndpoint

fn eq(&self, other: &AppInstanceUserEndpoint) -> 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 AppInstanceUserEndpoint