Class: Aws::ChimeSDKIdentity::Types::AppInstanceUserEndpoint

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-chimesdkidentity/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_messages ⇒ String

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.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#app_instance_user_arn ⇒ String

The ARN of the ‘AppInstanceUser`.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#created_timestamp ⇒ Time

The time at which an ‘AppInstanceUserEndpoint` was created.

Returns:

  • (Time) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#endpoint_attributes ⇒ Types::EndpointAttributes

The attributes of an ‘Endpoint`.

Returns:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#endpoint_id ⇒ String

The unique identifier of the ‘AppInstanceUserEndpoint`.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#endpoint_state ⇒ Types::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.

Returns:



293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#last_updated_timestamp ⇒ Time

The time at which an ‘AppInstanceUserEndpoint` was last updated.

Returns:

  • (Time) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#name ⇒ String

The name of the ‘AppInstanceUserEndpoint`.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#resource_arn ⇒ String

The ARN of the resource to which the endpoint belongs.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end

#type ⇒ String

The type of the ‘AppInstanceUserEndpoint`.

Returns:

  • (String) 


293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/aws-sdk-chimesdkidentity/types.rb', line 293

class AppInstanceUserEndpoint < Struct.new(
  :app_instance_user_arn,
  :endpoint_id,
  :name,
  :type,
  :resource_arn,
  :endpoint_attributes,
  :created_timestamp,
  :last_updated_timestamp,
  :allow_messages,
  :endpoint_state)
  SENSITIVE = [:name]
  include Aws::Structure
end