Class: Aws::PinpointSMSVoiceV2::Types::AssociateOriginationIdentityRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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) 


115
116
117
118
119
120
121
122
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 115

class AssociateOriginationIdentityRequest < Struct.new(
  :pool_id,
  :origination_identity,
  :iso_country_code,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iso_country_code ⇒ String

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

Returns:

  • (String) 


115
116
117
118
119
120
121
122
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 115

class AssociateOriginationIdentityRequest < Struct.new(
  :pool_id,
  :origination_identity,
  :iso_country_code,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Returns:

  • (String) 


115
116
117
118
119
120
121
122
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 115

class AssociateOriginationIdentityRequest < Struct.new(
  :pool_id,
  :origination_identity,
  :iso_country_code,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ String

The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Returns:

  • (String) 


115
116
117
118
119
120
121
122
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 115

class AssociateOriginationIdentityRequest < Struct.new(
  :pool_id,
  :origination_identity,
  :iso_country_code,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end