Class: Aws::PinpointSMSVoiceV2::Types::RequestSenderIdRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

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

Returns:

  • (String)


4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabledBoolean

By default this is set to false. When set to true the sender ID can't be deleted.

Returns:

  • (Boolean)


4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iso_country_codeString

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

  • (String)


4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#message_typesArray<String>

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

  • (Array<String>)


4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#sender_idString

The sender ID string to request.

Returns:

  • (String)


4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An array of tags (key and value pairs) to associate with the sender ID.

Returns:



4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 4757

class RequestSenderIdRequest < Struct.new(
  :sender_id,
  :iso_country_code,
  :message_types,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end