aws_sdk_pinpointsmsvoicev2/client/associate_origination_identity.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`AssociateOriginationIdentity`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`pool_id(impl Into<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::pool_id) / [`set_pool_id(Option<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::set_pool_id):<br>required: **true**<br><p>The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using <code>DescribePools</code>.</p><important> <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
7 /// - [`origination_identity(impl Into<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::origination_identity) / [`set_origination_identity(Option<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::set_origination_identity):<br>required: **true**<br><p>The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use <code>DescribePhoneNumbers</code> to find the values for PhoneNumberId and PhoneNumberArn, while <code>DescribeSenderIds</code> can be used to get the values for SenderId and SenderIdArn.</p><important> <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
8 /// - [`iso_country_code(impl Into<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::iso_country_code) / [`set_iso_country_code(Option<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::set_iso_country_code):<br>required: **true**<br><p>The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.</p><br>
9 /// - [`client_token(impl Into<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::set_client_token):<br>required: **false**<br><p>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.</p><br>
10 /// - On success, responds with [`AssociateOriginationIdentityOutput`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput) with field(s):
11 /// - [`pool_arn(Option<String>)`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput::pool_arn): <p>The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.</p>
12 /// - [`pool_id(Option<String>)`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput::pool_id): <p>The PoolId of the pool that is now associated with the origination identity.</p>
13 /// - [`origination_identity_arn(Option<String>)`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput::origination_identity_arn): <p>The PhoneNumberArn or SenderIdArn of the origination identity.</p>
14 /// - [`origination_identity(Option<String>)`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput::origination_identity): <p>The PhoneNumberId or SenderId of the origination identity.</p>
15 /// - [`iso_country_code(Option<String>)`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput::iso_country_code): <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.</p>
16 /// - On failure, responds with [`SdkError<AssociateOriginationIdentityError>`](crate::operation::associate_origination_identity::AssociateOriginationIdentityError)
17 pub fn associate_origination_identity(
18 &self,
19 ) -> crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder {
20 crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder::new(self.handle.clone())
21 }
22}