You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/pinpointsmsvoicev2/README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# aws-sdk-pinpointsmsvoicev2
2
2
3
-
Welcome to the _AWS End User Messaging SMS and Voice, version 2 API Reference_. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
3
+
Welcome to the _End User MessagingSMS, version 2 API Reference_. This guide provides information about End User MessagingSMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.
4
4
5
-
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
5
+
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User MessagingSMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User MessagingSMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
6
6
7
-
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the [AWS End User Messaging SMS User Guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html). The _AWS End User Messaging SMS User Guide _ provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.
7
+
If you're new to End User MessagingSMS, it's also helpful to review the [End User MessagingSMS User Guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html), where you'll find tutorials, code samples, and procedures that demonstrate how to use End User MessagingSMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User MessagingSMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.
8
8
9
9
__Regional availability__
10
10
11
-
The _AWS End User Messaging SMS and Voice version 2 API Reference_ is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see [Amazon Web Services Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) and [Amazon Pinpoint endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/pinpoint.html) in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see [Managing Amazon Web Services Regions](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon Web Services General Reference.
11
+
The _End User MessagingSMS version 2 API Reference_ is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see [Amazon Web Services Service Endpoints](https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region) and [Amazon Pinpoint endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/pinpoint.html) in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see [Managing Amazon Web Services Regions](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the Amazon Web Services General Reference.
12
12
13
-
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see [Amazon Web Services Global Infrastructure.](https://aws.amazon.com/about-aws/global-infrastructure/)
13
+
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see [Amazon Web Services Global Infrastructure.](http://aws.amazon.com/about-aws/global-infrastructure/)
14
14
15
15
## Getting Started
16
16
@@ -24,7 +24,7 @@ your project, add the following to your **Cargo.toml** file:
24
24
```toml
25
25
[dependencies]
26
26
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
Copy file name to clipboardExpand all lines: sdk/pinpointsmsvoicev2/src/client/associate_origination_identity.rs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@ impl super::Client {
3
3
/// Constructs a fluent builder for the [`AssociateOriginationIdentity`](crate::operation::associate_origination_identity::builders::AssociateOriginationIdentityFluentBuilder) operation.
4
4
///
5
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>
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 <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference_smsvoicev2/API_DescribePools.html">DescribePools</a>.</p><important> <p>If you are using a shared End User MessagingSMS; 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 End User MessagingSMS resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
8
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
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
10
/// - On success, responds with [`AssociateOriginationIdentityOutput`](crate::operation::associate_origination_identity::AssociateOriginationIdentityOutput) with field(s):
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
+
implsuper::Client{
3
+
/// Constructs a fluent builder for the [`CarrierLookup`](crate::operation::carrier_lookup::builders::CarrierLookupFluentBuilder) operation.
4
+
///
5
+
/// - The fluent builder is configurable:
6
+
/// - [`phone_number(impl Into<String>)`](crate::operation::carrier_lookup::builders::CarrierLookupFluentBuilder::phone_number) / [`set_phone_number(Option<String>)`](crate::operation::carrier_lookup::builders::CarrierLookupFluentBuilder::set_phone_number):<br>required: **true**<br><p>The phone number that you want to retrieve information about. You can provide the phone number in various formats including special characters such as parentheses, brackets, spaces, hyphens, periods, and commas. The service automatically converts the input to E164 format for processing.</p><br>
7
+
/// - On success, responds with [`CarrierLookupOutput`](crate::operation::carrier_lookup::CarrierLookupOutput) with field(s):
8
+
/// - [`e164_phone_number(String)`](crate::operation::carrier_lookup::CarrierLookupOutput::e164_phone_number): <p>The phone number in E164 format, sanitized from the original input by removing any formatting characters.</p>
9
+
/// - [`dialing_country_code(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::dialing_country_code): <p>The numeric dialing code for the country or region where the phone number was originally registered.</p>
10
+
/// - [`iso_country_code(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::iso_country_code): <p>The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.</p>
11
+
/// - [`country(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::country): <p>The name of the country where the phone number was originally registered.</p>
12
+
/// - [`mcc(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::mcc): <p>The phone number's mobile country code, for mobile phone number types</p>
13
+
/// - [`mnc(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::mnc): <p>The phone number's mobile network code, for mobile phone number types.</p>
14
+
/// - [`carrier(Option<String>)`](crate::operation::carrier_lookup::CarrierLookupOutput::carrier): <p>The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.</p>
15
+
/// - [`phone_number_type(PhoneNumberType)`](crate::operation::carrier_lookup::CarrierLookupOutput::phone_number_type): <p>Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.</p>
16
+
/// - On failure, responds with [`SdkError<CarrierLookupError>`](crate::operation::carrier_lookup::CarrierLookupError)
Copy file name to clipboardExpand all lines: sdk/pinpointsmsvoicev2/src/client/create_event_destination.rs
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ impl super::Client {
5
5
/// - The fluent builder is configurable:
6
6
/// - [`configuration_set_name(impl Into<String>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::configuration_set_name) / [`set_configuration_set_name(Option<String>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_configuration_set_name):<br>required: **true**<br><p>Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the <code>DescribeConfigurationSets</code> action.</p><br>
7
7
/// - [`event_destination_name(impl Into<String>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::event_destination_name) / [`set_event_destination_name(Option<String>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_event_destination_name):<br>required: **true**<br><p>The name that identifies the event destination.</p><br>
8
-
/// - [`matching_event_types(EventType)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::matching_event_types) / [`set_matching_event_types(Option<Vec::<EventType>>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_matching_event_types):<br>required: **true**<br><p>An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type.</p><note> <p>The <code>TEXT_SENT</code> event type is not supported.</p> </note><br>
8
+
/// - [`matching_event_types(EventType)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::matching_event_types) / [`set_matching_event_types(Option<Vec::<EventType>>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_matching_event_types):<br>required: **true**<br><p>An array of event types that determine which events to log. If "ALL" is used, then End User MessagingSMS logs every event type.</p><note> <p>The <code>TEXT_SENT</code> event type is not supported.</p> </note><br>
9
9
/// - [`cloud_watch_logs_destination(CloudWatchLogsDestination)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::cloud_watch_logs_destination) / [`set_cloud_watch_logs_destination(Option<CloudWatchLogsDestination>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_cloud_watch_logs_destination):<br>required: **false**<br><p>An object that contains information about an event destination for logging to Amazon CloudWatch Logs.</p><br>
10
10
/// - [`kinesis_firehose_destination(KinesisFirehoseDestination)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::kinesis_firehose_destination) / [`set_kinesis_firehose_destination(Option<KinesisFirehoseDestination>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_kinesis_firehose_destination):<br>required: **false**<br><p>An object that contains information about an event destination for logging to Amazon Data Firehose.</p><br>
11
11
/// - [`sns_destination(SnsDestination)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::sns_destination) / [`set_sns_destination(Option<SnsDestination>)`](crate::operation::create_event_destination::builders::CreateEventDestinationFluentBuilder::set_sns_destination):<br>required: **false**<br><p>An object that contains information about an event destination for logging to Amazon SNS.</p><br>
0 commit comments