aws_sdk_ssmcontacts/client/create_contact_channel.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 [`CreateContactChannel`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`contact_id(impl Into<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::contact_id) / [`set_contact_id(Option<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_contact_id):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.</p><br>
7 /// - [`name(impl Into<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_name):<br>required: **true**<br><p>The name of the contact channel.</p><br>
8 /// - [`r#type(ChannelType)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::type) / [`set_type(Option<ChannelType>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_type):<br>required: **true**<br><p>Incident Manager supports three types of contact channels:</p> <ul> <li> <p><code>SMS</code></p></li> <li> <p><code>VOICE</code></p></li> <li> <p><code>EMAIL</code></p></li> </ul><br>
9 /// - [`delivery_address(ContactChannelAddress)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::delivery_address) / [`set_delivery_address(Option<ContactChannelAddress>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_delivery_address):<br>required: **true**<br><p>The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p></li> <li> <p>VOICE - '+' followed by the country code and phone number</p></li> <li> <p>EMAIL - any standard email format</p></li> </ul><br>
10 /// - [`defer_activation(bool)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::defer_activation) / [`set_defer_activation(Option<bool>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_defer_activation):<br>required: **false**<br><p>If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.</p><br>
11 /// - [`idempotency_token(impl Into<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::idempotency_token) / [`set_idempotency_token(Option<String>)`](crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::set_idempotency_token):<br>required: **false**<br><p>A token ensuring that the operation is called only once with the specified details.</p><br>
12 /// - On success, responds with [`CreateContactChannelOutput`](crate::operation::create_contact_channel::CreateContactChannelOutput) with field(s):
13 /// - [`contact_channel_arn(String)`](crate::operation::create_contact_channel::CreateContactChannelOutput::contact_channel_arn): <p>The Amazon Resource Name (ARN) of the contact channel.</p>
14 /// - On failure, responds with [`SdkError<CreateContactChannelError>`](crate::operation::create_contact_channel::CreateContactChannelError)
15 pub fn create_contact_channel(&self) -> crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder {
16 crate::operation::create_contact_channel::builders::CreateContactChannelFluentBuilder::new(self.handle.clone())
17 }
18}