@aws-sdk/client-socialmessaging

Description

AWS SDK for JavaScript SocialMessaging Client for Node.js, Browser and React Native.

Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables
application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the
Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.

The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.

If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is
Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The
Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use
Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications.
The guide also provides key information, such as integration with other Amazon Web Services
services, and the quotas that apply to use of the service.

Regional availability

The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated 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 and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see
Managing
Amazon Web Services Regions in the Amazon Web Services General
Reference.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-socialmessaging
using your favorite package manager:
- npm install @aws-sdk/client-socialmessaging
- yarn add @aws-sdk/client-socialmessaging
- pnpm add @aws-sdk/client-socialmessaging

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SocialMessagingClient and
the commands you need, for example ListTagsForResourceCommand:

``js
// ES5 example
const { SocialMessagingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-socialmessaging");
`

`ts
// ES6+ example
import { SocialMessagingClient, ListTagsForResourceCommand } from "@aws-sdk/client-socialmessaging";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new SocialMessagingClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListTagsForResourceCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-socialmessaging";
const client = new AWS.SocialMessaging({ region: "REGION" });

// async/await.
try {
const data = await client.listTagsForResource(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listTagsForResource(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listTagsForResource(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-socialmessaging` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

AssociateWhatsAppBusinessAccount

Command API Reference / Input / Output

CreateWhatsAppMessageTemplate

Command API Reference / Input / Output

CreateWhatsAppMessageTemplateFromLibrary

Command API Reference / Input / Output

CreateWhatsAppMessageTemplateMedia

Command API Reference / Input / Output

DeleteWhatsAppMessageMedia

Command API Reference / Input / Output

DeleteWhatsAppMessageTemplate

Command API Reference / Input / Output

DisassociateWhatsAppBusinessAccount

Command API Reference / Input / Output

GetLinkedWhatsAppBusinessAccount

Command API Reference / Input / Output

GetLinkedWhatsAppBusinessAccountPhoneNumber

Command API Reference / Input / Output

GetWhatsAppMessageMedia

Command API Reference / Input / Output

GetWhatsAppMessageTemplate

Command API Reference / Input / Output

ListLinkedWhatsAppBusinessAccounts

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWhatsAppMessageTemplates

Command API Reference / Input / Output

ListWhatsAppTemplateLibrary

Command API Reference / Input / Output

PostWhatsAppMessageMedia

Command API Reference / Input / Output

PutWhatsAppBusinessAccountEventDestinations

Command API Reference / Input / Output

SendWhatsAppMessage

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateWhatsAppMessageTemplate

Command API Reference / Input / Output