Class: Aws::ChimeSDKIdentity::Types::RegisterAppInstanceUserEndpointRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:app_instance_user_arn, :name, :resource_arn, :client_request_token]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_messagesString

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.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#app_instance_user_arnString

The ARN of the AppInstanceUser.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#client_request_tokenString

The idempotency token for each client request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#endpoint_attributesTypes::EndpointAttributes

The attributes of an Endpoint.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#nameString

The name of the AppInstanceUserEndpoint.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#resource_arnString

The ARN of the resource to which the endpoint belongs.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end

#typeString

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.

Returns:

  • (String)


1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
# File 'gems/aws-sdk-chimesdkidentity/lib/aws-sdk-chimesdkidentity/types.rb', line 1045

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, :resource_arn, :client_request_token]
  include Aws::Structure
end