Class: Aws::Connect::Types::CreateEmailAddressRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :email_address, :display_name]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

  • (String) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end

#description ⇒ String

The description of the email address.

Returns:

  • (String) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end

#display_name ⇒ String

The display name of email address

Returns:

  • (String) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end

#email_address ⇒ String

The email address with the instance, in [^\s@]+@\.[^\s@] format.

Returns:

  • (String) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

  • (String) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, { “Tags”: “key2”:“value2” }.

Returns:

  • (Hash<String,String>) 


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
 
# File 'lib/aws-sdk-connect/types.rb', line 3896

class CreateEmailAddressRequest < Struct.new(
  :description,
  :instance_id,
  :email_address,
  :display_name,
  :tags,
  :client_token)
  SENSITIVE = [:description, :email_address, :display_name]
  include Aws::Structure
end