Class: Aws::ChimeSDKIdentity::Types::RegisterAppInstanceUserEndpointRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ChimeSDKIdentity::Types::RegisterAppInstanceUserEndpointRequest
- Defined in:
- gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:app_instance_user_arn, :name]
Instance Attribute Summary collapse
-
#allow_messages ⇒ String
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages.
-
#app_instance_user_arn ⇒ String
The ARN of the
AppInstanceUser
. -
#client_request_token ⇒ String
The unique ID assigned to the request.
-
#endpoint_attributes ⇒ Types::EndpointAttributes
The attributes of an
Endpoint
. -
#name ⇒ String
The name of the
AppInstanceUserEndpoint
. -
#resource_arn ⇒ String
The ARN of the resource to which the endpoint belongs.
-
#type ⇒ String
The type of the
AppInstanceUserEndpoint
.
Instance Attribute Details
#allow_messages ⇒ String
Boolean that controls whether the AppInstanceUserEndpoint is opted
in to receive messages. ALL
indicates the endpoint receives all
messages. NONE
indicates the endpoint receives no messages.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#app_instance_user_arn ⇒ String
The ARN of the AppInstanceUser
.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#client_request_token ⇒ String
The unique ID assigned to the request. Use different tokens to register other endpoints.
A suitable default value is auto-generated. You should normally not need to pass this option.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#endpoint_attributes ⇒ Types::EndpointAttributes
The attributes of an Endpoint
.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#name ⇒ String
The name of the AppInstanceUserEndpoint
.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#resource_arn ⇒ String
The ARN of the resource to which the endpoint belongs.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |
#type ⇒ String
The type of the AppInstanceUserEndpoint
. Supported types:
APNS
: The mobile notification service for an Apple device.APNS_SANDBOX
: The sandbox environment of the mobile notification service for an Apple device.GCM
: The mobile notification service for an Android device.
Populate the ResourceArn
value of each type as PinpointAppArn
.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 |
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1432 class RegisterAppInstanceUserEndpointRequest < Struct.new( :app_instance_user_arn, :name, :type, :resource_arn, :endpoint_attributes, :client_request_token, :allow_messages) SENSITIVE = [:app_instance_user_arn, :name] include Aws::Structure end |